fallow-config 3.22.0

Configuration types and workspace discovery for fallow codebase intelligence
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Configuration loading and resolution for fallow.
//!
//! Owns the user-facing config model ([`FallowConfig`] and its sections),
//! config-file discovery and `extends` inheritance, validation of
//! user-supplied globs and patterns, and resolution into the pre-compiled
//! [`ResolvedConfig`] the analysis crates consume. Also hosts workspace and
//! `package.json` discovery, declarative external plugin definitions, rule
//! packs, and the in-place config editing used by `fallow fix`.
//!
//! Config section structs such as [`RulesConfig`] are not `#[non_exhaustive]`
//! and gain new public fields in minor releases as rules are added, so
//! exhaustive struct literals in downstream code are source-breaking on
//! upgrade. Construct them with struct update syntax, for example
//! `RulesConfig { unused_files: Severity::Off, ..RulesConfig::default() }`,
//! to stay source-compatible.

#![warn(missing_docs)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        reason = "tests use unwrap and expect to keep fixture setup concise"
    )
)]

mod config;
mod config_writer;
mod external_plugin;
mod fixability;
/// JSONC parsing helpers pinning the dialect fallow accepts.
pub mod jsonc;
pub mod levenshtein;
mod rule_pack;
mod workspace;

pub use config::*;
pub use config_writer::*;
pub use external_plugin::*;
pub use fixability::*;
pub use rule_pack::*;
pub use workspace::*;

use std::path::{Path, PathBuf};

/// Basename of the local walkthrough viewed-state ledger inside the cache dir.
const WALKTHROUGH_STATE_FILE: &str = "walkthrough-state.json";

/// Path to the local `fallow review --walkthrough` viewed-state ledger inside a
/// resolved cache directory (default `<root>/.fallow`, already gitignored).
///
/// Pure path join, mirroring the `cache.bin` / `graph-cache.bin` / `churn.bin`
/// conventions; the file IO and serde live in the CLI crate to keep this crate
/// free of side effects.
#[must_use]
pub fn walkthrough_state_path(cache_dir: &Path) -> PathBuf {
    cache_dir.join(WALKTHROUGH_STATE_FILE)
}

#[cfg(test)]
mod walkthrough_state_path_tests {
    use super::walkthrough_state_path;
    use std::path::Path;

    #[test]
    fn joins_state_file_under_cache_dir() {
        let path = walkthrough_state_path(Path::new("/project/.fallow"));
        assert_eq!(path, Path::new("/project/.fallow/walkthrough-state.json"));
    }
}