Skip to main content

fallow_config/config/
mod.rs

1mod boundaries;
2mod dependency_ignore;
3mod duplicates_config;
4mod entry_span;
5mod finding_ignore;
6mod flags;
7mod format;
8pub mod glob_validation;
9mod health;
10mod ignore_patterns;
11mod legacy_glob;
12mod mutation;
13mod parsing;
14mod resolution;
15mod resolve;
16mod rules;
17mod similar_code;
18mod used_class_members;
19
20#[expect(
21    clippy::redundant_pub_crate,
22    reason = "this module is glob re-exported from lib.rs, so `pub` would leak the helper into the public API; pub(crate) keeps it internal to the crate"
23)]
24pub(crate) use boundaries::wildcard_placement_error;
25pub use boundaries::{
26    AuthoredRule, BoundaryCallsConfig, BoundaryConfig, BoundaryCoverageConfig, BoundaryPreset,
27    BoundaryRule, BoundaryZone, ForbiddenCallRule, ForbiddenCallee, InvalidForbiddenCallee,
28    LogicalGroup, LogicalGroupStatus, RedundantRootPrefix, ResolvedBoundaryConfig,
29    ResolvedBoundaryCoverageConfig, ResolvedBoundaryRule, ResolvedZone, UnknownZoneRef,
30    ZoneReferenceKind, ZoneValidationError,
31};
32pub use dependency_ignore::{IgnoreDependencyMatcher, is_dependency_glob};
33pub use duplicates_config::{
34    DetectionMode, DuplicatesConfig, NormalizationConfig, ResolvedNormalization,
35};
36pub use entry_span::ConfigEntrySpan;
37pub use finding_ignore::FindingIgnoreMatcher;
38pub use flags::{FlagsConfig, SdkPattern};
39pub use format::OutputFormat;
40pub use glob_validation::compile_path_glob;
41pub use health::{
42    ChangeCouplingConfig, EmailMode, HealthConfig, HealthThresholdOverride, OwnershipConfig,
43};
44pub use ignore_patterns::{IgnorePatternSet, UNLIFTABLE_IGNORE_SEGMENTS};
45pub use legacy_glob::{
46    LegacyGlobGroup, LegacyGlobNarrowing, find_legacy_glob_narrowings, has_single_segment_wildcard,
47    suggest_cross_directory_rewrite,
48};
49pub use mutation::{MutationConfig, MutationOperatorName, MutationRunner};
50pub use parsing::{CONFIG_FILE_NAMES, ConfigLoadOptions};
51pub use resolution::{
52    AnalysisSnapshot, CACHE_DIR_ENV, CACHE_MAX_SIZE_ENV, CompiledIgnoreCatalogReferenceRule,
53    CompiledIgnoreDependencyOverrideRule, CompiledIgnoreExportRule, ConfigOverride,
54    DEFAULT_IGNORE_PATTERNS, DEFAULT_MAX_FILE_SIZE_BYTES, DEFAULT_MAX_FILE_SIZE_MB,
55    IgnoreCatalogReferenceRule, IgnoreDependencyOverrideRule, IgnoreExportRule,
56    PACKAGE_BASELINES_ENV, ResolvedConfig, ResolvedOverride, cache_config_hash,
57    cache_dir_env_override, cache_dir_from_env_value, cache_max_size_env_override,
58    cache_max_size_from_env_value, package_baselines_disabled_by_env_value,
59    resolve_max_file_size_bytes,
60};
61pub use resolve::ResolveConfig;
62pub use rules::{
63    KNOWN_RULE_NAMES, PartialRulesConfig, RulesConfig, Severity, closest_known_rule_name,
64    default_severity_for_kind, is_opt_in_kind,
65};
66pub use similar_code::SimilarCodeConfig;
67pub use used_class_members::{ScopedUsedClassMemberRule, UsedClassMemberRule};
68
69use schemars::JsonSchema;
70use serde::{Deserialize, Deserializer, Serialize};
71use std::ops::Not;
72use std::path::PathBuf;
73
74use crate::external_plugin::ExternalPluginDef;
75use crate::workspace::WorkspaceConfig;
76
77/// Value of the `ignoreExportsUsedInFile` config key: whether an export
78/// referenced elsewhere in its own file is suppressed from `unused-export`.
79#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
80#[serde(untagged, rename_all = "camelCase")]
81pub enum IgnoreExportsUsedInFileConfig {
82    /// Blanket toggle: `true` suppresses any export with a same-file use,
83    /// regardless of kind. The default is `false`.
84    Bool(bool),
85    /// Knip-parity object form restricting the suppression to type-only
86    /// exports.
87    ByKind(IgnoreExportsUsedInFileByKind),
88}
89
90impl Default for IgnoreExportsUsedInFileConfig {
91    fn default() -> Self {
92        Self::Bool(false)
93    }
94}
95
96impl From<bool> for IgnoreExportsUsedInFileConfig {
97    fn from(value: bool) -> Self {
98        Self::Bool(value)
99    }
100}
101
102impl From<IgnoreExportsUsedInFileByKind> for IgnoreExportsUsedInFileConfig {
103    fn from(value: IgnoreExportsUsedInFileByKind) -> Self {
104        Self::ByKind(value)
105    }
106}
107
108impl IgnoreExportsUsedInFileConfig {
109    /// Whether any form of the same-file-use suppression is active (the bool
110    /// form is `true`, or either by-kind field is set).
111    #[must_use]
112    pub const fn is_enabled(self) -> bool {
113        match self {
114            Self::Bool(value) => value,
115            Self::ByKind(kind) => kind.type_ || kind.interface,
116        }
117    }
118
119    /// Whether an export with a same-file use should be suppressed, given
120    /// whether fallow classified it as type-only. The bool form suppresses
121    /// regardless of kind; the by-kind form suppresses type-only exports only.
122    #[must_use]
123    pub const fn suppresses(self, is_type_only: bool) -> bool {
124        match self {
125            Self::Bool(value) => value,
126            Self::ByKind(kind) => is_type_only && (kind.type_ || kind.interface),
127        }
128    }
129}
130
131/// Object form of `ignoreExportsUsedInFile` (`{ "type": ..., "interface": ... }`),
132/// restricting the same-file-use suppression to type-only exports.
133#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
134#[serde(rename_all = "camelCase")]
135pub struct IgnoreExportsUsedInFileByKind {
136    /// When `true`, enables the same-file-use suppression for type-only exports (serialized as `type`; part of the object form of `ignoreExportsUsedInFile`). Because fallow groups type aliases and interfaces under one issue kind, setting either `type` or `interface` enables the identical type-only suppression, applied only to exports fallow classifies as type-only.
137    #[serde(default, rename = "type")]
138    pub type_: bool,
139    /// When `true`, enables the same-file-use suppression for type-only exports (part of the object form of `ignoreExportsUsedInFile`). Fallow does not distinguish interfaces from type aliases in this issue kind, so `interface` behaves identically to `type`: setting either one turns on the type-only same-file suppression.
140    #[serde(default)]
141    pub interface: bool,
142}
143
144/// Options for the `unused-component-props` rule.
145///
146/// Lets a project exempt component props whose local destructure binding name
147/// matches a regex from `unused-component-props`, honoring the
148/// "accepted-but-intentionally-unused" leading-underscore convention (Svelte 5
149/// `$props()`, React destructure) that mirrors TypeScript `noUnusedParameters`
150/// and ESLint `@typescript-eslint/no-unused-vars` `varsIgnorePattern` /
151/// `argsIgnorePattern`. Opt-in; an unset `ignorePattern` leaves the rule's
152/// behavior unchanged.
153#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
154#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
155pub struct UnusedComponentPropsConfig {
156    /// Regex matched against each declared prop's LOCAL destructure binding name
157    /// (e.g. `_stage` in `let { stage: _stage } = $props()`), which falls back
158    /// to the public prop name when there is no alias. A prop whose local name
159    /// matches is treated as intentionally unused and never reported as
160    /// `unused-component-props`. Matching is unanchored (substring), like
161    /// ESLint's `RegExp.test`, so anchor with `^_` to match a leading
162    /// underscore. Compiled and validated at config load (an invalid regex fails
163    /// load). Applies to Vue, Svelte, Astro, and React/Preact props.
164    #[serde(default, skip_serializing_if = "Option::is_none")]
165    pub ignore_pattern: Option<String>,
166}
167
168impl UnusedComponentPropsConfig {
169    /// True when no option is set, so serialization can omit the section.
170    #[must_use]
171    pub fn is_default(&self) -> bool {
172        self.ignore_pattern.is_none()
173    }
174}
175
176/// Options for the `circular-dependencies` rule.
177///
178/// The default leaves the rule unchanged: every runtime import edge takes
179/// part in cycle detection, and only type-only edges are skipped.
180#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
181#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
182pub struct CircularDependenciesConfig {
183    /// Skip import edges that load their target on demand or on another
184    /// thread when fallow looks for cycles. A literal `import()` inside a
185    /// function, a template `import()`, a lazy `import.meta.glob`, a worker
186    /// URL and a webpack worker loader request (`worker-loader!./work.js`)
187    /// are lazy edges. A top-level `await import()`, `require()` and an
188    /// eager `import.meta.glob` load before the module finishes, so they stay.
189    /// An edge that also carries a static import stays. Default `false`.
190    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
191    pub ignore_lazy_imports: bool,
192}
193
194impl CircularDependenciesConfig {
195    /// True when no option is set, so serialization can omit the section.
196    #[must_use]
197    pub const fn is_default(&self) -> bool {
198        !self.ignore_lazy_imports
199    }
200}
201
202/// The `fix` config section: settings for `fallow fix` apply behavior.
203#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
204#[serde(rename_all = "camelCase")]
205pub struct FixConfig {
206    /// Groups `fallow fix` settings for pnpm workspace catalog cleanup. Its only key, `deletePrecedingComments` (`auto` default, `always`, `never`), controls whether a comment block directly above a removed unused `pnpm-workspace.yaml` catalog entry is deleted with the entry.
207    #[serde(default)]
208    pub catalog: CatalogFixConfig,
209}
210
211/// The `fix.catalog` section: how `fallow fix` cleans up unused
212/// `pnpm-workspace.yaml` catalog entries.
213#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
214#[serde(rename_all = "camelCase")]
215pub struct CatalogFixConfig {
216    /// Controls whether comment lines immediately above an unused `pnpm-workspace.yaml` catalog entry are removed when `fallow fix` deletes that entry: `auto` (default: delete only when the comment block is preceded by a blank line or sits directly under the parent catalog header, and never when it is a section banner like `# ====`), `always` (always remove the adjacent comment block), or `never` (leave all preceding comments). A `fallow-keep` marker anywhere in the block always preserves it regardless of this setting. Set `never` for teams that keep hand-authored notes above catalog pins.
217    #[serde(default)]
218    pub delete_preceding_comments: CatalogPrecedingCommentPolicy,
219}
220
221/// Value of `fix.catalog.deletePrecedingComments`: what happens to comment
222/// lines directly above a catalog entry that `fallow fix` removes. A
223/// `fallow-keep` marker in the block always preserves it regardless of policy.
224#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
225#[serde(rename_all = "lowercase")]
226pub enum CatalogPrecedingCommentPolicy {
227    /// Delete the adjacent comment block only when heuristics attribute it to
228    /// the entry (preceded by a blank line or directly under the catalog
229    /// header) and it is not a section banner. The default.
230    #[default]
231    Auto,
232    /// Always delete the adjacent comment block with the entry.
233    Always,
234    /// Never delete preceding comments.
235    Never,
236}
237
238/// Completeness policy for opt-in TypeScript semantic analysis.
239#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
240#[serde(rename_all = "kebab-case")]
241pub enum TypeAwareRequire {
242    /// Keep conservative findings and report semantic gaps without failing.
243    #[default]
244    BestEffort,
245    /// Fail the quality gate when any requested semantic query is incomplete.
246    Complete,
247}
248
249impl From<TypeAwareRequire> for fallow_types::semantic::SemanticCompletenessRequirement {
250    fn from(value: TypeAwareRequire) -> Self {
251        match value {
252            TypeAwareRequire::BestEffort => Self::BestEffort,
253            TypeAwareRequire::Complete => Self::Complete,
254        }
255    }
256}
257
258/// Shared opt-in configuration for TypeScript semantic analysis.
259#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
260#[serde(deny_unknown_fields, rename_all = "camelCase")]
261pub struct TypeAwareConfig {
262    /// Enable the optional TypeScript semantic pass. Disabled by default.
263    #[serde(default)]
264    pub enabled: bool,
265    /// TypeScript project config paths, resolved relative to the project root.
266    #[serde(default, skip_serializing_if = "Vec::is_empty")]
267    pub projects: Vec<String>,
268    /// Decide whether partial semantic analysis is advisory or gating.
269    #[serde(default, skip_serializing_if = "is_default_type_aware_require")]
270    pub require: TypeAwareRequire,
271}
272
273#[expect(
274    clippy::trivially_copy_pass_by_ref,
275    reason = "serde skip_serializing_if callbacks receive field values by reference"
276)]
277fn is_default_type_aware_require(value: &TypeAwareRequire) -> bool {
278    matches!(value, TypeAwareRequire::BestEffort)
279}
280
281impl TypeAwareConfig {
282    /// True when the section equals its default (disabled, no projects,
283    /// best-effort), so serialization can omit it.
284    #[must_use]
285    pub fn is_default(&self) -> bool {
286        !self.enabled && self.projects.is_empty() && self.require == TypeAwareRequire::BestEffort
287    }
288}
289
290/// Schema for `extends`. The loader accepts one string or an array of strings
291/// and normalizes both to a list before it deserializes the config (#3351).
292fn extends_schema(_generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
293    schemars::json_schema!({
294        "anyOf": [
295            { "type": "string" },
296            { "type": "array", "items": { "type": "string" } }
297        ]
298    })
299}
300
301/// The user-facing fallow configuration as authored in `.fallowrc.json` /
302/// `.fallowrc.jsonc` / `fallow.toml` / `.fallow.toml`.
303///
304/// Every field documents its serialized meaning, default, and precedence
305/// against CLI flags and environment variables where they exist.
306/// `FallowConfig::resolve` compiles the loaded config (globs, regexes,
307/// plugin and rule-pack discovery) into a [`ResolvedConfig`] for analysis.
308/// Unknown keys are rejected at load so typos fail loud.
309#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
310#[serde(deny_unknown_fields, rename_all = "camelCase")]
311// Both `.fallowrc.json` and `.fallowrc.jsonc` are read with the JSONC dialect
312// from `crate::jsonc::parse_options`, so the schema declares the same dialect.
313// JSON language service clients (VS Code, Zed) read these two keywords off the
314// root object and otherwise flag syntax the loader accepts. They are
315// annotations only: nothing in fallow reads them back.
316#[schemars(extend("allowComments" = true, "allowTrailingCommas" = true))]
317pub struct FallowConfig {
318    /// A string pointing at fallow's JSON Schema URL, used only by editors for autocomplete and validation of the config file; it has no effect on analysis and is stripped before serialization (serde skip_serializing, writeOnly in the schema). Set it to `./node_modules/fallow/schema.json` for npm installs (version-aligned, offline, avoids VS Code's untrusted-remote-schema prompt), or `https://raw.githubusercontent.com/fallow-rs/fallow/main/schema.json` for non-npm installs; any other value is ignored by fallow.
319    #[serde(rename = "$schema", default, skip_serializing)]
320    pub schema: Option<String>,
321
322    /// The lowest fallow version this config is written for, as `MAJOR.MINOR.PATCH`. An older binary stops with a message naming both versions instead of failing on the first field it does not recognize, so a config committed to a shared repository says which upgrade it needs rather than reading like a typo. Optional and unset by default; set it in the same change that adds a field introduced in a newer version. It gates nothing on its own: an unknown key still fails on a binary at or above this version, because there the key really is a typo.
323    #[serde(default, skip_serializing_if = "Option::is_none")]
324    pub minimum_version: Option<String>,
325
326    /// A single parent config source, or an ordered array of them, to inherit before this file's own keys apply; each source is a file-relative path, an `npm:<package>` specifier, or an `https://` URL (`http://` is rejected), deep-merged in order so objects merge field-by-field while arrays and scalars in this file replace the parent's, with cycle and depth guards. Set it to share a base config across a monorepo or team; it is consumed at load and stripped before serialization (serde skip_serializing).
327    #[serde(default, skip_serializing)]
328    #[schemars(schema_with = "extends_schema")]
329    pub extends: Vec<String>,
330
331    /// An array of project-root-relative glob patterns whose matching files are seeded as manual entry points, on top of the framework and package.json entries fallow discovers automatically, so their transitive imports are not reported as unused. Set it (e.g. `["src/main.ts"]`) when a file is a real runtime root that no plugin or manifest declares; patterns are validated at load and matched against discovered files. A single `*` stays within one path segment; use `**` to match across directories.
332    #[serde(default)]
333    pub entry: Vec<String>,
334
335    /// An array of project-root-relative glob patterns for files to exclude from analysis entirely; entries are unioned with fallow's built-in defaults (**/node_modules/**, **/dist/**, **/build/**, **/.git/**, **/coverage/**, **/*.min.js, **/*.min.mjs, **/*.min.cjs, **/*.bundle.js), so custom globs add to rather than replace them. Set it (e.g. `["generated/**"]`) to drop generated or vendored trees from every detector; patterns are validated at load. A `!`-prefixed entry is an exception that applies after the defaults and the positive patterns: `"!src/policy/coverage/**"` brings back hand-written source under a built-in default such as `**/coverage/**`, and `"!.config/**"` adds a hidden directory to discovery. Paths under `node_modules` or `.git` can not be lifted, and a `!` entry that names one of these segments is a config error. A single `*` stays within one path segment; use `**` to match across directories.
336    #[serde(default)]
337    pub ignore_patterns: Vec<String>,
338
339    /// An array of project-root-relative glob patterns whose source-owned dead-code findings are hidden after analysis without excluding matching files from discovery, parsing, resolution, or the module graph. Use `/` as the path separator on every platform. Positive patterns select paths to hide; `!`-prefixed patterns keep matching paths reportable, and a negated-only array reports only those exception paths. A finding with multiple source owners is hidden only when every owner matches, so a cycle, duplicate-export group, or unlisted dependency with any reportable location remains visible. Architecture, policy, suppression-hygiene, and framework-correctness findings remain visible even when a referenced path matches, as do manifest-owned findings that no source file owns: unused dependencies, unused dev and optional dependencies, catalog entries, and dependency overrides. Use `ignorePatterns` instead when a generated or vendored file must not be analyzed at all. A matching file that parses with errors reports no `source-parse-degraded` diagnostic, and its partial parse does not mark other findings as incomplete; use this only for files that are broken on purpose, such as syntax-error test fixtures. A single `*` stays within one path segment; use `**` to match across directories.
340    #[serde(default, skip_serializing_if = "Vec::is_empty")]
341    pub ignore_findings: Vec<String>,
342
343    /// Declares inline external framework plugins as data (array of plugin objects), each with `name` plus optional `enablers` (package names that activate it) or richer `detection` (dependency/file-existence/`all`/`any` checks, taking priority over `enablers`), `entryPoints` (+ `entryPointRole` runtime/support/test), `configPatterns`, `alwaysUsed`, `toolingDependencies`, `usedExports` (`{ pattern, exports }`), and `usedClassMembers`. Set it to keep a custom or in-house framework's entry points, config files, and conventions reachable without a Rust plugin; these definitions are appended to plugins discovered via `plugins`, `.fallow/plugins/`, and root `fallow-plugin-*` files (first occurrence of a name wins), and cannot do AST-based config parsing.
344    #[serde(default)]
345    pub framework: Vec<ExternalPluginDef>,
346
347    /// Monorepo workspace configuration. `patterns` adds workspace package roots beyond manifest discovery; `changedSince` maps exact project-root-relative workspace roots to Git baseline refs. A global changed-since request overrides those per-package baselines.
348    #[serde(default)]
349    pub workspaces: Option<WorkspaceConfig>,
350
351    /// A list of package names or package-name globs excluded from BOTH unused-dependency and unlisted-dependency detection, so a runtime-provided or otherwise-untracked package (e.g. `bun:sqlite`, a peer supplied at deploy time) is never flagged as unused when declared nor as unlisted when imported. Set it for packages fallow cannot observe being used and cannot observe being declared. An entry without glob characters matches the package name exactly; an entry with `*`, `?`, `[` or `{` is a glob in the `ignorePatterns` syntax matched against the package name, so `@acme/*` covers every package in the `@acme` scope.
352    #[serde(default)]
353    pub ignore_dependencies: Vec<String>,
354
355    /// A list of command names whose file arguments fallow does not make entry points. Fallow reads commands in package.json scripts (root and workspace packages), CI files (GitHub Actions and GitLab CI), Dockerfiles, Procfiles, and fly.toml files, and a file that a command names (such as `node scripts/seed.ts`) normally becomes an entry point. A listed command still counts as a used dependency, and its `--config` file is still tracked. Formatters and linters (ESLint, Prettier, Oxlint, Oxfmt, Biome, Stylelint, and similar tools) never make their targets entry points, so they do not need to be listed. Set it for a command whose file arguments are data, not code that runs (e.g. `["my-codegen"]`), or use `["*"]` to turn off entry points from all commands and declare real entries in `entry`. A name matches the command after environment, package-manager, and wrapper prefixes (`npx`, `pnpm exec`, `yarn run`, `varlock run --`), by exact file name; `*` is the only wildcard.
356    #[serde(default, skip_serializing_if = "Vec::is_empty")]
357    pub ignore_command_entries: Vec<String>,
358
359    /// A list of glob patterns that suppress only `unresolved-import` findings whose raw import specifier matches; it does not change dependency usage accounting or resolver behavior. Patterns match the import string as written (not a filesystem path), so list both `@example/icons` and `@example/icons/**` to cover a bare package and its subpaths; parent-relative generated specifiers like `../generated/**` are valid, and broad values like `**` can hide real missing modules.
360    #[serde(default)]
361    pub ignore_unresolved_imports: Vec<String>,
362
363    /// A list of per-file rules that exempt named exports from `unused-export` and from duplicate-exports grouping for files matching a glob. Each entry is `{ file: <glob>, exports: [<name>, ...] }` where `exports: ["*"]` exempts every export in the file and a name list exempts only those names; built for component-library barrels (shadcn/Radix/bits-ui `index.ts`) that intentionally re-export the same short names across many files. A single `*` stays within one path segment; use `**` to match across directories.
364    #[serde(default)]
365    pub ignore_exports: Vec<IgnoreExportRule>,
366
367    /// A list of rules that suppress `unresolved-catalog-reference` findings (a workspace `package.json` referencing a `catalog:` or `catalog:<name>` that the catalog does not declare); config-only because `package.json` has no inline-suppression comment surface. Each entry needs a `package` (exact match) plus optional `catalog` (exact catalog-name match) and `consumer` (glob on the consuming package.json path); use it for staged catalog migrations where the catalog edit lands in a separate change.
368    #[serde(default, skip_serializing_if = "Vec::is_empty")]
369    pub ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>,
370
371    /// A list of rules that suppress `unused-dependency-override` and `misconfigured-dependency-override` findings for pnpm `overrides` entries; config-only, matched against the override's target package. Each entry needs a `package` (exact match) plus an optional `source` to scope the suppression to `"pnpm-workspace.yaml"` or `"package.json"`.
372    #[serde(default, skip_serializing_if = "Vec::is_empty")]
373    pub ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>,
374
375    /// Controls whether an export referenced only by another symbol in the same file is treated as used (suppressed from `unused-export`) until it becomes completely unreferenced; references inside an export specifier itself (`export { foo }`, `export default foo`) do not count as same-file uses. Accepts `true`/`false` (default `false`, suppress nothing) or the knip-parity object `{ "type": true, "interface": true }`, which restricts the suppression to type-only exports; fallow groups type aliases and interfaces under one kind, so both object fields behave identically.
376    #[serde(default)]
377    pub ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig,
378
379    /// A list of decorator names that no longer grant a class member automatic exemption from `unused-class-member`: a member whose every decorator is in this set is checked normally, while a member carrying any decorator NOT listed here stays skipped (frameworks consume decorated members reflectively). Dotted entries match the full decorator path (`ns.foo`) and bare entries match the leftmost segment (so `"decorators"` collapses every `@decorators.*`); both `"@step"` and `"step"` are accepted (leading `@` stripped), and an unmatched entry emits a one-time warning.
380    #[serde(default, skip_serializing_if = "Vec::is_empty")]
381    pub ignore_decorators: Vec<String>,
382
383    /// A list of class-member names or glob patterns treated as framework-used, so a method a library invokes reflectively (ag-Grid `agInit`/`refresh`, Web Component `connectedCallback`) is not reported as `unused-class-member`; it applies to class members only, not enum members. Each entry is either a plain string/glob (`"agInit"`, `"enter*"`, `"*"`) applied to every class, or a scoped object `{ extends?, implements?, members: [...] }` that applies only when the class matches that heritage clause (a scoped rule requires `extends` or `implements`); patterns matching zero members warn once.
384    #[serde(default)]
385    pub used_class_members: Vec<UsedClassMemberRule>,
386
387    /// Configures clone detection: `enabled` (default true), `mode` (`strict`, `mild` default, `weak`, `semantic`, from least to most identifier/literal blinding; `strict` and `mild` are equivalent under fallow's AST tokenizer, `weak` blinds string literals, `semantic` blinds all identifiers and literals for Type-2 renamed-variable detection), `near` (false, add bounded function-scoped near-miss detection), `minTokens` (50), `minLines` (5), `minOccurrences` (integer >= 2, deserialization fails below 2), `threshold` (max duplication percentage, 0 = no limit), `ignore` globs, `ignoredClones` (reviewed clone keys to hide until their content or occurrence count changes), `ignoreDefaults` (true, merge built-in generated-file ignores), `skipLocal` (only report cross-directory clones), `ignoreSymlinks` (false, omit clone instances whose path is a symlink or lies under a symlinked directory), `crossLanguage` (strip TS type annotations to match .ts against .js), `ignoreImports` (true, strip ES import/re-export/top-level require wiring from the token stream), and `normalization` (per-flag `ignoreIdentifiers`/`ignoreStringValues`/`ignoreNumericValues` overrides on top of `mode`). Raise `minOccurrences` to focus on widespread copy-paste, enable `near` for gapped structural clones, or set `mode` to `semantic` to catch renamed-variable exact clones.
388    #[serde(default)]
389    pub duplicates: DuplicatesConfig,
390
391    /// Configures the explicit local `similar-code` candidate workflow:
392    /// `threshold` (0.80, model-specific cosine floor), `minLines` (3), and
393    /// additional `ignore` globs. Provider identity, setup, executables,
394    /// endpoints, credentials, and consent cannot be set by project config.
395    #[serde(default)]
396    pub similar_code: SimilarCodeConfig,
397
398    /// Configures the explicit `fallow mutation` workflow: `runner` (`auto`
399    /// or `vitest`), `operators` (kebab-case names, default each operator),
400    /// `minScore` (0 to 100; a lower score exits with code 1), and
401    /// `concurrency` (half the logical cores). No key starts a run, and the
402    /// side-effect override is a CLI flag only.
403    #[serde(default, skip_serializing_if = "MutationConfig::is_default")]
404    pub mutation: MutationConfig,
405
406    /// Sets complexity and health thresholds for `fallow health` (also applied in combined `fallow` and `fallow audit`): `maxCyclomatic` (20), `maxCognitive` (15), `maxCrap` (30.0, findings at or above this are reported), `crapRefactorBand` (5, cyclomatic band below `maxCyclomatic` where a secondary refactor action is added), `maxUnitSize` (max function lines before a large-function finding, 60), `coverage`/`coverageRoot` (Istanbul coverage path and path-prefix strip for accurate CRAP), `ignore` globs (remove files from findings AND the health score), `thresholdOverrides` (per-file/per-function ceilings via `files`/`functions`/`maxCyclomatic`/`maxCognitive`/`maxCrap`/`maxUnitSize`/`reason`), `ownership` (`botPatterns` and `emailMode` for `--ownership`), and `suggestInlineSuppression` (true, emit `suppress-line` action hints in JSON). Raise thresholds to relax which functions are flagged, wire `coverage` for real CRAP scores, or exempt generated/test files via `ignore` (drops them from the score too) or `thresholdOverrides` (keeps them visible under a higher ceiling). The four `max*` thresholds govern findings only and never move `health_score`: its penalties use fixed calibration so grades stay comparable across projects, and `ignore` is the lever that removes files from the score.
407    #[serde(default)]
408    pub health: HealthConfig,
409
410    /// Opts into TypeScript semantic analysis for project-wide symbol use,
411    /// provenance, API surface, symbol impact, and public-signature coupling.
412    /// This does not surface compiler diagnostics or typed lint rules.
413    #[serde(default, skip_serializing_if = "TypeAwareConfig::is_default")]
414    pub type_aware: TypeAwareConfig,
415
416    /// Sets per-issue-type severity, keyed by kebab-case rule id: `error` reports and fails CI (non-zero exit), `warn` reports without failing, `off` disables detection and reporting entirely (e.g. `{ "unused-files": "error", "unused-exports": "warn", "private-type-leaks": "off" }`). Set a rule `off` to silence it, `warn` to demote below CI gating, or `error` to promote a warn/off-default rule to gating; most rules default to `error`, dev/optional-dependency and component/store/inject/CSS/catalog rules default to `warn`, and opt-in rules (`private-type-leaks`, `deprecated-exports-in-use`, `security-*`, `prop-drilling`, `thin-wrapper`, `duplicate-prop-shape`, `coverage-gaps`, `feature-flags`, `require-suppression-reason`) default to `off`. Singular aliases (`unused-file`) and `warning`/`none` severity spellings are accepted.
417    #[serde(default)]
418    pub rules: RulesConfig,
419
420    #[serde(
421        default,
422        skip_serializing_if = "UnusedComponentPropsConfig::is_default"
423    )]
424    /// Options for the `unused-component-props` rule, currently only `ignorePattern`: a regex matched against each declared prop's local destructure binding name (falling back to the public prop name when unaliased) to exempt intentionally-unused props such as the leading-underscore convention. Set `{ "ignorePattern": "^_" }` to skip props like `_stage`; matching is unanchored (substring, like ESLint's `RegExp.test`) so anchor with `^`, the pattern is validated at config load (invalid regex fails load), and it applies to Vue, Svelte, Astro, and React/Preact props (unset leaves the rule unchanged).
425    pub unused_component_props: UnusedComponentPropsConfig,
426
427    #[serde(
428        default,
429        skip_serializing_if = "CircularDependenciesConfig::is_default"
430    )]
431    /// Options for the `circular-dependencies` rule, currently only `ignoreLazyImports`. Set `{ "ignoreLazyImports": true }` to skip import edges that load on demand or on another thread (an `import()` inside a function, a template `import()`, a lazy `import.meta.glob`, a worker URL, a webpack worker loader request such as `worker-loader!./work.js`) when fallow looks for cycles. A top-level `await import()`, `require()`, an eager glob, and an edge that also has a static import stay in the cycle graph. Default `false` leaves the rule unchanged.
432    pub circular_dependencies: CircularDependenciesConfig,
433
434    /// Configures architecture boundary enforcement: which source directories belong to which named zone and which zones may import which others, reported as boundary-violation, boundary-coverage-violation, and boundary-call-violation findings (severity via rules.boundary-violation, default error). Set to enforce a layered/module architecture; the object holds `preset` (one of layered, hexagonal, feature-sliced, bulletproof, whose default zones/rules are merged in with the user-declared zones/rules taking precedence), `zones` (each with `name`, `patterns`, `autoDiscover`, optional `root`), `rules` (each with `from`, `allow`, `allowTypeOnly` target-zone lists), `coverage` (`requireAllFiles` plus `allowUnmatched` globs for files matching no zone), and `calls` (a `forbidden` list of `{from, callee}` banned-call rules per zone).
435    #[serde(default)]
436    pub boundaries: BoundaryConfig,
437
438    /// Configures feature-flag detection: `sdkPatterns` (custom flag-evaluating call signatures, each `{ function, nameArg (zero-based arg index of the flag name, default 0), provider? }`, merged with built-ins for LaunchDarkly, Statsig, Unleash, GrowthBook, Split, PostHog, Vercel Flags, ConfigCat, Flagsmith, Optimizely, and Eppo), `envPrefixes` (env-var prefixes marking `process.env.*` and `import.meta.env.*` accesses as flags, merged with built-ins), and `configObjectHeuristics` (default false; when true, property accesses on objects whose name contains `feature`/`flag`/`toggle` are reported as low-confidence flags). Set `sdkPatterns`/`envPrefixes` to teach fallow a proprietary flag SDK or naming convention, or enable `configObjectHeuristics` for projects that read flags off config objects (higher false-positive rate). Feature-flag findings surface only when the `feature-flags` rule is enabled (default `off`).
439    #[serde(default)]
440    pub flags: FlagsConfig,
441
442    /// Scopes the opt-in `fallow security` catalogue: which candidate categories run and which extra local identifiers count as HTTP request objects. Set when tuning security-candidate detection; the object holds `categories` (an object with `include` and/or `exclude` string arrays of catalogue category ids, where `include` restricts to a whitelist and `exclude` removes from the admitted set, both unset admits all ordinary categories) and `requestReceivers` (a string array of project-local names that extend, not replace, the built-in `*.query`/`*.params`/`*.body` source-receiver allowlist). The `hardcoded-secret` and `secret-to-network` categories are include-required: they fire only when explicitly listed in `categories.include`, even when no include list is otherwise set. The valid category ids are enumerated (with title, CWE, and include-required flag) in the `security_categories` block of `fallow schema`, and also listed by `fallow security --help`; they are not in this config-schema.
443    #[serde(default)]
444    pub security: SecurityConfig,
445
446    /// Configures `fallow fix` behavior. Currently holds one nested section, `catalog` (a `CatalogFixConfig`), whose only key `deletePrecedingComments` (`auto` default, `always`, `never`) governs whether comment lines directly above a removed unused `pnpm-workspace.yaml` catalog entry are deleted with it.
447    #[serde(default)]
448    pub fix: FixConfig,
449
450    /// Configures the module resolver. Its one key `conditions` is a list of additional package.json `exports`/`imports` condition names to honor, matched at higher priority than fallow's built-ins (`development`, `import`, `require`, `default`, `types`, `node`, plus `react-native`/`browser` when the React Native or Expo plugin is active). Set it when a package's `exports` map has custom branches (e.g. `worker`, `deno`, `edge`) that fallow should follow instead of the default branch.
451    #[serde(default)]
452    pub resolve: ResolveConfig,
453
454    /// Enables production mode, which excludes test/spec/story/dev files from discovery and forces `unused-dev-dependencies` and `unused-optional-dependencies` to `off`. Accepts a boolean (default false) applied to all analyses, or a per-analysis object `{ deadCode?, health?, dupes? }` (each boolean, default false) that scopes production mode to individual analyses in combined `fallow` and `fallow audit`. Set it to analyze only shipped code; the `--production`/`--no-production` and `--production-{dead-code,health,dupes}` CLI flags and `FALLOW_PRODUCTION*` env vars override this value (CLI flags win, then per-analysis env, then global env, then config).
455    #[serde(default)]
456    pub production: ProductionConfig,
457
458    /// List of paths (relative to the project root, must resolve within it) to external plugin definition files or directories in JSONC/JSON/TOML, loaded in addition to the auto-discovered `.fallow/plugins/` directory and root `fallow-plugin-*` files. Set it to load plugin definitions kept outside those default locations; a path resolving outside the project root is skipped with a `tracing::warn`, and paths listed here are searched before the auto-discovered locations (first occurrence of a plugin name wins).
459    #[serde(default)]
460    pub plugins: Vec<String>,
461
462    /// Paths to declarative rule-pack files (JSON or JSONC), relative to the
463    /// project root. Each pack declares `banned-call`, `banned-import`, or
464    /// `banned-effect` rules that report as `policy-violation` findings. Packs
465    /// are pure data: no project code is executed. Invalid or missing packs
466    /// fail config load.
467    #[serde(default, skip_serializing_if = "Vec::is_empty")]
468    pub rule_packs: Vec<String>,
469
470    /// An array of project-root-relative glob patterns for files loaded at runtime by a mechanism the static graph cannot see (dynamic path resolution, config-driven loading); matching files are seeded as entry points so they and their imports stay reachable. Empty by default; set it (e.g. `["plugins/**/*.ts", "locales/**/*.json"]`) for plugin or locale trees pulled in dynamically. A single `*` stays within one path segment; use `**` to match across directories.
471    #[serde(default)]
472    pub dynamically_loaded: Vec<String>,
473
474    /// An ordered list of per-file rule-severity overrides: each entry re-severities specific analysis rules for files its globs match, layered on top of the top-level `rules` defaults. Set to relax or tighten rules for a subset of paths (e.g. downgrade unused-exports to warn under a generated directory); each entry has `files` (glob-pattern array) and `rules` (a partial per-rule severity map of error/warn/off). Entries apply in list order and a file matched by several entries takes every matching entry's overrides (later entries win on conflict); inter-file rules (duplicate-exports, circular-dependencies, re-export-cycle) have no effect in an override (fallow warns during analysis and points to the right mechanism: top-level `ignoreExports` for duplicate-exports, a file-level `// fallow-ignore-file` comment for the others). A single `*` stays within one path segment; use `**` to match across directories.
475    #[serde(default)]
476    pub overrides: Vec<ConfigOverride>,
477
478    /// A project-root-relative path to a CODEOWNERS file, used by fallow health --hotspots --ownership to attribute declared owners and compute unowned/drifting ownership state; setting it overrides the default probe order (CODEOWNERS, .github/CODEOWNERS, .gitlab/CODEOWNERS, docs/CODEOWNERS). String, defaults to null (auto-probe the standard locations); set it only when the CODEOWNERS file lives at a non-standard location.
479    #[serde(default, skip_serializing_if = "Option::is_none")]
480    pub codeowners: Option<String>,
481
482    /// An array of internal workspace package names (or globs matched against workspace package names) whose public API is intentionally consumed outside the analyzed graph; their entry points and re-export surface become reachability roots, so their exported files, exports, and class members are not reported as unused. Set it (e.g. `["@myorg/shared-lib", "@myorg/*"]`) for library packages in a monorepo that ship an API to external consumers; only meaningful when workspaces are present (an empty list or no workspaces is a no-op).
483    #[serde(default)]
484    pub public_packages: Vec<String>,
485
486    /// Holds a saved issue-count baseline that the `--fail-on-regression` gate compares the current run against, failing only when counts grow beyond tolerance relative to the baseline. Usually written by `--save-baseline` rather than hand-authored; the object has a single `baseline` sub-key holding per-issue-type counts (total_issues plus per-kind fields like unused_exports, boundary_violations, policy_violations, each defaulting to 0). Absent means no baseline is embedded in config.
487    #[serde(default, skip_serializing_if = "Option::is_none")]
488    pub regression: Option<RegressionConfig>,
489
490    /// Sets in-repo defaults for `fallow audit` (the changed-files quality gate) so CLI flags need not repeat per run. Set to pin audit behavior; the object holds `gate` (`new-only` or `all`, which findings drive the verdict), `css`/`cssDeep` (booleans toggling styling analysis and the project-wide CSS reachability pass), `deadCodeBaseline`/`healthBaseline`/`dupesBaseline` (per-sub-analysis baseline file paths), and `cacheMaxAgeDays` (GC window in days for the reusable base-snapshot worktree cache). The matching CLI flag overrides each field.
491    #[serde(default, skip_serializing_if = "AuditConfig::is_empty")]
492    pub audit: AuditConfig,
493
494    /// When true, restricts this config's extends entries to file-relative paths that resolve inside the config file's own directory; any https:// URL, npm: package, or relative path escaping that directory is rejected at load with a hard error. Boolean, defaults to false (URL, npm, and any-relative extends are permitted); set it to true to harden a config against pulling in remote or out-of-tree bases.
495    #[serde(default)]
496    pub sealed: bool,
497
498    /// When true, exports of entry-point files are subject to unused-export detection instead of being auto-credited as used, so a typo'd or stray export in a framework route or package entry (e.g. meatdata for metadata) is flagged; plugin used_exports allowlists are still honored. Boolean, defaults to false; the CLI flag --include-entry-exports applies the same behavior for one run.
499    #[serde(default)]
500    pub include_entry_exports: bool,
501
502    /// When true, the report keeps the unused exports, unused types, unused class members and unused enum members of a file that is an unused file. Boolean, defaults to false: deleting an unused file removes these findings, so the report hides them and counts them in cascade_hidden. The CLI flag --show-cascade applies the same behavior for one run.
503    #[serde(default)]
504    pub show_cascade: bool,
505
506    /// When true, drops Nuxt convention-based entry-pattern fallbacks so genuinely-unreferenced convention files surface as unused-file. Component fallbacks are kept when nuxt.config customizes components: in a way fallow does not model, and composable/util fallbacks are kept when it customizes imports:; a config that scans no more than the Nuxt defaults (components: false, components: [], components: { dirs: [] }, components: true, imports: { scan: false }, imports: {}, imports: { dirs: [] }) is treated like the default and its fallbacks are dropped; imports: { autoImport: false } on its own is not, because it only switches the injection off while the same directories stay registered behind #imports. A nuxt.config that carries any top-level key fallow cannot read statically, a computed key, an accessor, or a spread such as { ...base, devtools: {} }, keeps both surfaces' fallbacks for that root, because the spread may hold the keys that decide. Only top-level keys count when the config object is readable: a nested key such as a routeRules path ending in components does not keep a fallback. Nested components or imports keys in $production, $development, $test or `$env.<name>`, and components or imports hooks (a components:* key or a nested components object in hooks, also inside those overrides), count as that surface's key; such an override object or hooks object that fallow cannot read statically falls back to a text match for the keys. Each root is classified on its own config plus the configs of its local layers, so one custom nuxt.config in a monorepo does not keep every other workspace's fallbacks. A local layer is a directory named in extends, or a `layers/<name>` directory, that holds a nuxt.config; its convention files are entry points with the flag off and auto-import sources with it on, and `#layers/<name>/` resolves to it by its $meta.name (a `layers/<name>` directory without one uses its directory name). A remote or package layer is only a dependency reference. Component names follow Nuxt: a component under components/global or components/islands is named after its own directory (components/global/Foo.vue is `<Foo>`), and .client, .server, .global and .island suffixes are stripped. A name imported or re-exported by hand from #components or #imports credits its convention file just like a template tag or a bare call; a namespace import names nothing and credits nothing. Boolean, defaults to false; set it for a Nuxt project that has explicitly configured its auto-import directories. Synthesis of auto-import graph edges (resolving `<Card />` or `useUserStore()` to their convention files) happens regardless of this flag.
507    #[serde(default)]
508    pub auto_imports: bool,
509
510    /// When true, the run fails with exit code 1 if fallow could not parse a source file cleanly (a `source-parse-degraded` entry in `workspace_diagnostics[]`), and the `parse-error` entry of `gate_outcomes` names each such file. Boolean, defaults to false, so a file the parser rejects only warns. Applies to `fallow dead-code`, `fallow health`, `fallow audit` and the bare `fallow` run; the CLI flag `--fail-on-parse-error` arms the same gate for one run. Older fallow versions reject this key as unknown, so pair it with `minimumVersion` set to the release that added it.
511    #[serde(default)]
512    pub fail_on_parse_error: bool,
513
514    /// Overrides the location and size ceiling of fallow's persistent extraction cache (default `.fallow/cache.bin` under the project root). Set to relocate the cache or cap its footprint; the object holds `dir` (cache directory, relative paths resolve from the project root) and `maxSizeMb` (extraction-cache size limit in megabytes). The `FALLOW_CACHE_MAX_SIZE` environment variable overrides `maxSizeMb`.
515    #[serde(default, skip_serializing_if = "CacheConfig::is_default")]
516    pub cache: CacheConfig,
517}
518
519/// Scopes `fallow security` catalogue behavior. An absent category block admits
520/// every catalogue category. `hardcoded-secret` is include-required and only
521/// runs when explicitly listed in `security.categories.include`.
522#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
523#[serde(deny_unknown_fields, rename_all = "camelCase")]
524pub struct SecurityConfig {
525    /// Include/exclude filter over category ids (e.g. `dangerous-html`).
526    #[serde(default, skip_serializing_if = "Option::is_none")]
527    pub categories: Option<SecurityCategories>,
528    /// Additional project-local names for HTTP request objects. These names
529    /// extend the built-in receiver allowlist for `*.query`, `*.params`, and
530    /// `*.body` source patterns. They do not replace the built-ins and do not
531    /// gate `*.searchParams`, which intentionally stays ungated.
532    #[serde(default, skip_serializing_if = "Vec::is_empty")]
533    pub request_receivers: Vec<String>,
534}
535
536impl SecurityConfig {
537    /// The configured `requestReceivers` trimmed, lowercased, and deduplicated
538    /// in first-seen order, with empty entries dropped; the form the matcher
539    /// compares receiver names against (matching is case-insensitive).
540    #[must_use]
541    pub fn normalized_request_receivers(&self) -> Vec<String> {
542        let mut receivers = Vec::new();
543        for receiver in &self.request_receivers {
544            let normalized = receiver.trim().to_ascii_lowercase();
545            if !normalized.is_empty() && !receivers.contains(&normalized) {
546                receivers.push(normalized);
547            }
548        }
549        receivers
550    }
551
552    /// False when any configured receiver is empty or whitespace-only, which
553    /// config validation reports as an error instead of silently dropping it.
554    #[must_use]
555    pub fn request_receivers_are_valid(&self) -> bool {
556        self.request_receivers
557            .iter()
558            .all(|receiver| !receiver.trim().is_empty())
559    }
560}
561
562/// Include/exclude lists scoping the active security categories. When `include`
563/// is set, only those categories are active; `exclude` removes categories from
564/// the admitted set. Both unset admits catalogue categories. `hardcoded-secret`
565/// still requires explicit inclusion.
566#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
567#[serde(deny_unknown_fields, rename_all = "camelCase")]
568pub struct SecurityCategories {
569    /// Catalogue category ids to admit. When set, all others are excluded.
570    #[serde(default, skip_serializing_if = "Option::is_none")]
571    pub include: Option<Vec<String>>,
572    /// Catalogue category ids to remove from the admitted set.
573    #[serde(default, skip_serializing_if = "Option::is_none")]
574    pub exclude: Option<Vec<String>>,
575}
576
577/// The `cache` config section: location and size ceiling of fallow's
578/// persistent caches (default directory `<root>/.fallow`).
579#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
580#[serde(deny_unknown_fields, rename_all = "camelCase")]
581pub struct CacheConfig {
582    /// Directory for fallow's persistent analysis cache. Relative paths resolve
583    /// from the project root.
584    #[serde(default, skip_serializing_if = "Option::is_none")]
585    pub dir: Option<PathBuf>,
586    /// Maximum size of the persistent extraction cache, in megabytes.
587    #[serde(default, skip_serializing_if = "Option::is_none")]
588    pub max_size_mb: Option<u32>,
589}
590
591impl CacheConfig {
592    /// True when neither field is set, so serialization can omit the section.
593    #[must_use]
594    pub fn is_default(&self) -> bool {
595        self.dir.is_none() && self.max_size_mb.is_none()
596    }
597}
598
599/// The analysis families production mode can be scoped to independently via
600/// the object form of the `production` config key.
601#[derive(Debug, Clone, Copy, PartialEq, Eq)]
602pub enum ProductionAnalysis {
603    /// Unused files/exports/dependencies detection.
604    DeadCode,
605    /// Complexity and health scoring.
606    Health,
607    /// Clone detection.
608    Dupes,
609}
610
611/// Value of the `production` config key: excludes test/spec/story/dev files
612/// from discovery, either globally or per analysis family.
613#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, JsonSchema)]
614#[serde(untagged)]
615pub enum ProductionConfig {
616    /// Boolean form applying to every analysis. The default is `false`.
617    Global(bool),
618    /// Object form (`{ deadCode?, health?, dupes? }`) scoping production mode
619    /// per analysis family.
620    PerAnalysis(PerAnalysisProductionConfig),
621}
622
623impl<'de> Deserialize<'de> for ProductionConfig {
624    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
625    where
626        D: Deserializer<'de>,
627    {
628        struct ProductionConfigVisitor;
629
630        impl<'de> serde::de::Visitor<'de> for ProductionConfigVisitor {
631            type Value = ProductionConfig;
632
633            fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
634                formatter.write_str("a boolean or per-analysis production config object")
635            }
636
637            fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
638            where
639                E: serde::de::Error,
640            {
641                Ok(ProductionConfig::Global(value))
642            }
643
644            fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
645            where
646                A: serde::de::MapAccess<'de>,
647            {
648                PerAnalysisProductionConfig::deserialize(
649                    serde::de::value::MapAccessDeserializer::new(map),
650                )
651                .map(ProductionConfig::PerAnalysis)
652            }
653        }
654
655        deserializer.deserialize_any(ProductionConfigVisitor)
656    }
657}
658
659impl Default for ProductionConfig {
660    fn default() -> Self {
661        Self::Global(false)
662    }
663}
664
665impl From<bool> for ProductionConfig {
666    fn from(value: bool) -> Self {
667        Self::Global(value)
668    }
669}
670
671impl Not for ProductionConfig {
672    type Output = bool;
673
674    fn not(self) -> Self::Output {
675        !self.any_enabled()
676    }
677}
678
679impl ProductionConfig {
680    /// Whether production mode applies to `analysis` under this config.
681    #[must_use]
682    pub const fn for_analysis(self, analysis: ProductionAnalysis) -> bool {
683        match self {
684            Self::Global(value) => value,
685            Self::PerAnalysis(config) => match analysis {
686                ProductionAnalysis::DeadCode => config.dead_code,
687                ProductionAnalysis::Health => config.health,
688                ProductionAnalysis::Dupes => config.dupes,
689            },
690        }
691    }
692
693    /// The boolean form's value; `false` for the per-analysis form, which has
694    /// no global toggle.
695    #[must_use]
696    pub const fn global(self) -> bool {
697        match self {
698            Self::Global(value) => value,
699            Self::PerAnalysis(_) => false,
700        }
701    }
702
703    /// Whether production mode is enabled for at least one analysis family.
704    #[must_use]
705    pub const fn any_enabled(self) -> bool {
706        match self {
707            Self::Global(value) => value,
708            Self::PerAnalysis(config) => config.dead_code || config.health || config.dupes,
709        }
710    }
711}
712
713/// Object form of the `production` config key, scoping production mode to
714/// individual analysis families in combined `fallow` and `fallow audit`.
715#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
716#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
717pub struct PerAnalysisProductionConfig {
718    /// When `production` is a per-analysis object, enables production mode for dead-code analysis only (boolean, default false): unused-files/exports/dependencies detection excludes test/spec/story/dev files and forces `unused-dev-dependencies`/`unused-optional-dependencies` to `off`, while health and dupes stay on the full tree. Set it to scope production analysis to dead code independently.
719    pub dead_code: bool,
720    /// When `production` is a per-analysis object, enables production mode for the health/complexity analysis only (boolean, default false), so `fallow health` in combined `fallow` and `fallow audit` scores only shipped code (test/spec/story/dev files excluded) while dead-code and dupes stay on the full tree. Set it to scope production analysis to health independently.
721    pub health: bool,
722    /// When `production` is a per-analysis object, enables production mode for duplication analysis only (boolean, default false), so clone detection runs on shipped code only (test/spec/story/dev files excluded) while dead-code and health stay on the full tree. Set it to scope production analysis to dupes independently.
723    pub dupes: bool,
724}
725
726/// The `audit` config section: in-repo defaults for `fallow audit`, each
727/// overridable by its matching CLI flag.
728#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
729#[serde(rename_all = "camelCase")]
730pub struct AuditConfig {
731    /// Selects which findings affect the `fallow audit` verdict: `new-only` (default) fails only on findings introduced by the current changeset (running a base-snapshot attribution pass), while `all` fails on every finding in changed files and skips that pass. Set to `all` to gate the full backlog in changed files; the `--gate` CLI flag overrides this.
732    #[serde(default, skip_serializing_if = "AuditGate::is_default")]
733    pub gate: AuditGate,
734
735    /// Selects how a worsened complexity finding affects the `fallow audit` verdict under `gate: new-only`. A worsened finding was already in the base snapshot, and a measured value is higher now. Any growth of cyclomatic, cognitive or CRAP counts. The line count must grow by at least 5 lines, and it includes comments and blank lines. `warn` (default) makes the verdict at least `warn` and does not fail the run. `error` counts a worsened finding like an introduced finding. `off` reports only the growth of a metric that the finding exceeds as worsened, which gives at least `warn`. A finding whose exceeded metric grew is worsened when it stays in its severity tier (`moderate`, `high`, `critical`), and introduced when it moves to a higher tier or exceeds a metric that the base finding did not exceed. The `--worsened` CLI flag overrides this.
736    #[serde(default, skip_serializing_if = "AuditWorsened::is_default")]
737    pub worsened: AuditWorsened,
738
739    /// Toggles the dead-code sub-analysis in `fallow audit` (unused files, exports, types, members and dependencies, plus boundary violations and circular dependencies, which come from the same pass). Defaults to on when unset; set `false` to leave it out of the verdict, summary and attribution, on the head and on the base snapshot. `fallow audit --skip dead-code` turns it off for one run and `--only` replaces this selection. The review brief (`--brief`, `fallow review`) keeps every sub-analysis because it reads the module graph.
740    #[serde(default, skip_serializing_if = "Option::is_none")]
741    pub dead_code: Option<bool>,
742
743    /// Toggles the health sub-analysis in `fallow audit` (complexity and CRAP findings, plus styling findings, which come from the same pass). Defaults to on when unset; set `false` to leave it out of the verdict, summary and attribution, on the head and on the base snapshot. `fallow audit --skip health` turns it off for one run and `--only` replaces this selection.
744    #[serde(default, skip_serializing_if = "Option::is_none")]
745    pub health: Option<bool>,
746
747    /// Toggles the duplication sub-analysis in `fallow audit`. Defaults to on when unset; set `false` to leave clone groups out of the verdict, summary and attribution, on the head and on the base snapshot. `fallow audit --skip dupes` turns it off for one run and `--only` replaces this selection.
748    #[serde(default, skip_serializing_if = "Option::is_none")]
749    pub dupes: Option<bool>,
750
751    /// Toggles styling analytics (CSS and CSS-in-JS) in the `fallow audit` health sub-pass; these findings are descriptive and verdict-neutral by default (they change the exit code only when a css-* rule is set to error). Defaults to on when unset; set `false` to skip styling analysis. The `--no-css` CLI flag forces it off regardless.
752    #[serde(default, skip_serializing_if = "Option::is_none")]
753    pub css: Option<bool>,
754
755    /// Toggles the project-wide CSS reachability pass in `fallow audit`, whose cross-file findings are narrowed back to changed anchors. Defaults to on when unset and runs only when css analytics are enabled; set `false` to keep local styling analytics but skip the whole-project scan. The `--css-deep` flag re-enables it and `--no-css-deep` forces it off.
756    #[serde(default, skip_serializing_if = "Option::is_none")]
757    pub css_deep: Option<bool>,
758
759    /// Path to a saved dead-code baseline file (produced by `fallow dead-code --save-baseline`) that the audit's dead-code sub-analysis compares against, suppressing pre-existing dead-code issues. The `--dead-code-baseline` CLI flag overrides it and both resolve relative to the project root; each sub-analysis uses a distinct baseline format, so this is separate from `healthBaseline` and `dupesBaseline`.
760    #[serde(default, skip_serializing_if = "Option::is_none")]
761    pub dead_code_baseline: Option<String>,
762
763    /// Path to a saved health/complexity baseline file (produced by `fallow health --save-baseline`) that the audit's health sub-analysis compares against, suppressing pre-existing complexity/health findings. The `--health-baseline` CLI flag overrides it and both resolve relative to the project root; its baseline format is distinct from the dead-code and dupes baselines.
764    #[serde(default, skip_serializing_if = "Option::is_none")]
765    pub health_baseline: Option<String>,
766
767    /// Path to a saved duplication baseline file (produced by `fallow dupes --save-baseline`) that the audit's duplication sub-analysis compares clone groups against, suppressing pre-existing duplicate clones. The `--dupes-baseline` CLI flag overrides it and both resolve relative to the project root; its baseline format is distinct from the dead-code and health baselines.
768    #[serde(default, skip_serializing_if = "Option::is_none")]
769    pub dupes_baseline: Option<String>,
770
771    /// Garbage-collection threshold, in whole days, for the persistent reusable base-snapshot worktree caches `fallow audit` creates: entries older than this window are swept on each audit run. Set to control cache accumulation; `0` disables the sweep and unset defaults to 30 days. Each sweep also reclaims abandoned entries minted under other repo identities (deleted or moved repos, other git worktrees) once they age past this repo's threshold; entries whose recorded owner root still exists are skipped and stay governed by that repo's own setting. The same window applies to the base-snapshot files in the project cache directory, counted from their last use; independent of this window, audit keeps only the newest 32 of those files. The `FALLOW_AUDIT_CACHE_MAX_AGE_DAYS` environment variable overrides this field.
772    #[serde(default, skip_serializing_if = "Option::is_none")]
773    pub cache_max_age_days: Option<u32>,
774
775    /// Overrides the top-level `typeAware.enabled` opt-in for `fallow audit` only: set `false` to keep persistent type-aware analysis on for cleanup commands (`dead-code`, `fix`, `health`) while the audit gate stays syntactic, or `true` to enable it for audit alone. Unset inherits `typeAware.enabled`. The `--type-aware`/`--no-type-aware` CLI flags and the `FALLOW_TYPE_AWARE` environment variable both take precedence over this field.
776    #[serde(default, skip_serializing_if = "Option::is_none")]
777    pub type_aware: Option<bool>,
778}
779
780impl AuditConfig {
781    /// True when every field is unset, so serialization can omit the section.
782    #[must_use]
783    pub fn is_empty(&self) -> bool {
784        self.gate.is_default()
785            && self.worsened.is_default()
786            && self.dead_code.is_none()
787            && self.health.is_none()
788            && self.dupes.is_none()
789            && self.css.is_none()
790            && self.css_deep.is_none()
791            && self.dead_code_baseline.is_none()
792            && self.health_baseline.is_none()
793            && self.dupes_baseline.is_none()
794            && self.cache_max_age_days.is_none()
795            && self.type_aware.is_none()
796    }
797}
798
799/// Value of `audit.gate`: which findings drive the `fallow audit` verdict.
800#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
801#[serde(rename_all = "kebab-case")]
802pub enum AuditGate {
803    /// Fail only on findings the current changeset introduced, determined by
804    /// a base-snapshot attribution pass. The default.
805    #[default]
806    NewOnly,
807    /// Fail on every finding in changed files, skipping the attribution pass.
808    All,
809}
810
811impl AuditGate {
812    /// True for the default `new-only` gate, so serialization can omit it.
813    #[must_use]
814    pub const fn is_default(&self) -> bool {
815        matches!(self, Self::NewOnly)
816    }
817}
818
819/// Value of `audit.worsened`: how a worsened complexity finding affects the
820/// `fallow audit` verdict.
821#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
822#[serde(rename_all = "kebab-case")]
823pub enum AuditWorsened {
824    /// A worsened finding makes the verdict at least `warn` and does not fail
825    /// the run. The default.
826    #[default]
827    Warn,
828    /// A worsened finding counts like an introduced finding.
829    Error,
830    /// Growth only in metrics that the finding does not exceed stays
831    /// inherited. Growth of an exceeded metric stays worsened and gives at
832    /// least `warn`.
833    Off,
834}
835
836impl AuditWorsened {
837    /// True for the default `warn` mode, so serialization can omit it.
838    #[must_use]
839    pub const fn is_default(&self) -> bool {
840        matches!(self, Self::Warn)
841    }
842}
843
844/// The `regression` config section holding the saved issue-count baseline for
845/// the `--fail-on-regression` gate.
846#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
847#[serde(rename_all = "camelCase")]
848pub struct RegressionConfig {
849    /// The saved per-issue-type issue counts that `--fail-on-regression` compares the current run against; the gate fails only when counts grow beyond the configured tolerance. Typically written by `--save-baseline` rather than hand-authored; each field (total_issues plus per-kind counts like unused_exports, boundary_violations, policy_violations) is an integer defaulting to 0 when omitted. Absent means no baseline is embedded.
850    #[serde(default, skip_serializing_if = "Option::is_none")]
851    pub baseline: Option<RegressionBaseline>,
852}
853
854/// Saved per-issue-type counts written by `--save-baseline` and compared by
855/// `--fail-on-regression`. Every count defaults to `0` when its key is missing,
856/// so hand-trimmed baselines stay loadable.
857#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
858#[serde(rename_all = "camelCase")]
859pub struct RegressionBaseline {
860    /// Baseline count of optional component prop review candidates.
861    #[serde(default)]
862    pub absent_component_props: usize,
863
864    /// Compatibility identity for the analysis that produced these counts.
865    /// Missing values in existing configs are treated as syntactic.
866    #[serde(default)]
867    pub analysis_identity: fallow_types::semantic::SemanticAnalysisIdentity,
868    /// Baseline count across all issue types.
869    #[serde(default)]
870    pub total_issues: usize,
871    /// Baseline count of `unused-files` findings.
872    #[serde(default)]
873    pub unused_files: usize,
874    /// Baseline count of `unused-exports` findings.
875    #[serde(default)]
876    pub unused_exports: usize,
877    /// Baseline count of `unused-types` findings.
878    #[serde(default)]
879    pub unused_types: usize,
880    /// Baseline count of `unused-dependencies` findings.
881    #[serde(default)]
882    pub unused_dependencies: usize,
883    /// Baseline count of `unused-dev-dependencies` findings.
884    #[serde(default)]
885    pub unused_dev_dependencies: usize,
886    /// Baseline count of `unused-optional-dependencies` findings.
887    #[serde(default)]
888    pub unused_optional_dependencies: usize,
889    /// Baseline count of `unused-enum-members` findings.
890    #[serde(default)]
891    pub unused_enum_members: usize,
892    /// Baseline count of `unused-class-members` findings.
893    #[serde(default)]
894    pub unused_class_members: usize,
895    /// Baseline count of `unresolved-imports` findings.
896    #[serde(default)]
897    pub unresolved_imports: usize,
898    /// Baseline count of `unlisted-dependencies` findings.
899    #[serde(default)]
900    pub unlisted_dependencies: usize,
901    /// Baseline count of `duplicate-exports` findings.
902    #[serde(default)]
903    pub duplicate_exports: usize,
904    /// Baseline count of `circular-dependencies` findings.
905    #[serde(default)]
906    pub circular_dependencies: usize,
907    /// Baseline count of `re-export-cycle` findings.
908    #[serde(default)]
909    pub re_export_cycles: usize,
910    /// Baseline count of `package-cycle` findings.
911    #[serde(default)]
912    pub package_cycles: usize,
913    /// Baseline count of `type-only-dependencies` findings.
914    #[serde(default)]
915    pub type_only_dependencies: usize,
916    /// Baseline count of `test-only-dependencies` findings.
917    #[serde(default)]
918    pub test_only_dependencies: usize,
919    /// Baseline count of `dev-dependencies-in-production` findings.
920    #[serde(default)]
921    pub dev_dependencies_in_production: usize,
922    /// Baseline count of `boundary-violation` findings.
923    #[serde(default)]
924    pub boundary_violations: usize,
925    /// Baseline count of boundary-coverage-violation findings.
926    #[serde(default)]
927    pub boundary_coverage_violations: usize,
928    /// Baseline count of boundary-call-violation findings.
929    #[serde(default)]
930    pub boundary_call_violations: usize,
931    /// Baseline count of `policy-violation` findings.
932    #[serde(default)]
933    pub policy_violations: usize,
934}
935
936#[cfg(test)]
937mod tests {
938    use super::*;
939
940    #[test]
941    fn regression_baseline_preserves_absent_component_prop_count() {
942        let baseline: RegressionBaseline =
943            serde_json::from_value(serde_json::json!({"absentComponentProps":7})).unwrap();
944        assert_eq!(
945            serde_json::to_value(baseline).unwrap()["absentComponentProps"],
946            7
947        );
948    }
949
950    #[test]
951    fn default_config_has_empty_collections() {
952        let config = FallowConfig::default();
953        assert!(config.schema.is_none());
954        assert!(config.extends.is_empty());
955        assert!(config.entry.is_empty());
956        assert!(config.ignore_patterns.is_empty());
957        assert!(config.ignore_findings.is_empty());
958        assert!(config.framework.is_empty());
959        assert!(config.workspaces.is_none());
960        assert!(config.ignore_dependencies.is_empty());
961        assert!(config.ignore_exports.is_empty());
962        assert!(config.used_class_members.is_empty());
963        assert!(config.plugins.is_empty());
964        assert!(config.dynamically_loaded.is_empty());
965        assert!(config.overrides.is_empty());
966        assert!(config.public_packages.is_empty());
967        assert_eq!(
968            config.fix.catalog.delete_preceding_comments,
969            CatalogPrecedingCommentPolicy::Auto
970        );
971        assert!(!config.production);
972    }
973
974    #[test]
975    fn deserialize_empty_json_object() {
976        let config: FallowConfig = serde_json::from_str("{}").unwrap();
977        assert!(config.entry.is_empty());
978        assert!(!config.production);
979        assert!(!config.type_aware.enabled);
980        assert_eq!(config.type_aware.require, TypeAwareRequire::BestEffort);
981    }
982
983    #[test]
984    fn deserialize_type_aware_config() {
985        let config: FallowConfig = serde_json::from_str(
986            r#"{"typeAware":{"enabled":true,"projects":["tsconfig.app.json"],"require":"complete"}}"#,
987        )
988        .unwrap();
989
990        assert!(config.type_aware.enabled);
991        assert_eq!(config.type_aware.projects, ["tsconfig.app.json"]);
992        assert_eq!(config.type_aware.require, TypeAwareRequire::Complete);
993    }
994
995    #[test]
996    fn deserialize_type_aware_config_rejects_unknown_fields() {
997        let result = serde_json::from_str::<FallowConfig>(
998            r#"{"typeAware":{"enabled":true,"compilerDiagnostics":true}}"#,
999        );
1000        assert!(result.is_err());
1001    }
1002
1003    #[test]
1004    fn deserialize_json_with_all_top_level_fields() {
1005        let json = r#"{
1006            "$schema": "./node_modules/fallow/schema.json",
1007            "entry": ["src/main.ts"],
1008            "ignorePatterns": ["generated/**"],
1009            "ignoreFindings": ["**/*.test.ts", "!src/public/**"],
1010            "ignoreDependencies": ["postcss"],
1011            "production": true,
1012            "plugins": ["custom-plugin.toml"],
1013            "rules": {"unused-files": "warn"},
1014            "duplicates": {"enabled": false},
1015            "health": {"maxCyclomatic": 30}
1016        }"#;
1017        let config: FallowConfig = serde_json::from_str(json).unwrap();
1018        assert_eq!(
1019            config.schema.as_deref(),
1020            Some("./node_modules/fallow/schema.json")
1021        );
1022        assert_eq!(config.entry, vec!["src/main.ts"]);
1023        assert_eq!(config.ignore_patterns, vec!["generated/**"]);
1024        assert_eq!(
1025            config.ignore_findings,
1026            vec!["**/*.test.ts", "!src/public/**"]
1027        );
1028        assert_eq!(config.ignore_dependencies, vec!["postcss"]);
1029        assert!(config.production);
1030        assert_eq!(config.plugins, vec!["custom-plugin.toml"]);
1031        assert_eq!(config.rules.unused_files, Severity::Warn);
1032        assert!(!config.duplicates.enabled);
1033        assert_eq!(config.health.max_cyclomatic, 30);
1034    }
1035
1036    #[test]
1037    fn deserialize_json_deny_unknown_fields() {
1038        let json = r#"{"unknownField": true}"#;
1039        let result: Result<FallowConfig, _> = serde_json::from_str(json);
1040        assert!(result.is_err(), "unknown fields should be rejected");
1041    }
1042
1043    #[test]
1044    fn ignore_findings_serialization_is_canonical_and_sparse() {
1045        let default_value = serde_json::to_value(FallowConfig::default()).unwrap();
1046        assert!(default_value.get("ignoreFindings").is_none());
1047
1048        let config = FallowConfig {
1049            ignore_findings: vec!["**/*.test.ts".to_string(), "!src/public/**".to_string()],
1050            ..Default::default()
1051        };
1052        let value = serde_json::to_value(config).unwrap();
1053        assert_eq!(
1054            value.get("ignoreFindings"),
1055            Some(&serde_json::json!(["**/*.test.ts", "!src/public/**"]))
1056        );
1057    }
1058
1059    #[test]
1060    fn ignore_findings_deserializes_from_toml() {
1061        let config: FallowConfig =
1062            toml::from_str(r#"ignoreFindings = ["**/*.test.ts", "!src/public/**"]"#).unwrap();
1063
1064        assert_eq!(
1065            config.ignore_findings,
1066            vec!["**/*.test.ts", "!src/public/**"]
1067        );
1068    }
1069
1070    #[test]
1071    fn generic_ignore_alias_is_rejected() {
1072        let result = serde_json::from_str::<FallowConfig>(r#"{"ignore": ["**/*.test.ts"]}"#);
1073
1074        assert!(result.is_err());
1075    }
1076
1077    #[test]
1078    fn deserialize_json_production_mode_default_false() {
1079        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1080        assert!(!config.production);
1081    }
1082
1083    #[test]
1084    fn deserialize_json_production_mode_true() {
1085        let config: FallowConfig = serde_json::from_str(r#"{"production": true}"#).unwrap();
1086        assert!(config.production);
1087    }
1088
1089    #[test]
1090    fn deserialize_json_per_analysis_production_mode() {
1091        let config: FallowConfig = serde_json::from_str(
1092            r#"{"production": {"deadCode": false, "health": true, "dupes": false}}"#,
1093        )
1094        .unwrap();
1095        assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
1096        assert!(config.production.for_analysis(ProductionAnalysis::Health));
1097        assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
1098    }
1099
1100    #[test]
1101    fn deserialize_json_per_analysis_production_mode_rejects_unknown_fields() {
1102        let err = serde_json::from_str::<FallowConfig>(r#"{"production": {"healthTypo": true}}"#)
1103            .unwrap_err();
1104        assert!(
1105            err.to_string().contains("healthTypo"),
1106            "error should name the unknown field: {err}"
1107        );
1108    }
1109
1110    #[test]
1111    fn deserialize_json_dynamically_loaded() {
1112        let json = r#"{"dynamicallyLoaded": ["plugins/**/*.ts", "locales/**/*.json"]}"#;
1113        let config: FallowConfig = serde_json::from_str(json).unwrap();
1114        assert_eq!(
1115            config.dynamically_loaded,
1116            vec!["plugins/**/*.ts", "locales/**/*.json"]
1117        );
1118    }
1119
1120    #[test]
1121    fn deserialize_json_dynamically_loaded_defaults_empty() {
1122        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1123        assert!(config.dynamically_loaded.is_empty());
1124    }
1125
1126    #[test]
1127    fn deserialize_json_fix_catalog_delete_preceding_comments() {
1128        let config: FallowConfig =
1129            serde_json::from_str(r#"{"fix": {"catalog": {"deletePrecedingComments": "always"}}}"#)
1130                .unwrap();
1131        assert_eq!(
1132            config.fix.catalog.delete_preceding_comments,
1133            CatalogPrecedingCommentPolicy::Always
1134        );
1135    }
1136
1137    #[test]
1138    fn deserialize_json_fix_catalog_delete_preceding_comments_rejects_unknown_policy() {
1139        let err = serde_json::from_str::<FallowConfig>(
1140            r#"{"fix": {"catalog": {"deletePrecedingComments": "sometimes"}}}"#,
1141        )
1142        .unwrap_err();
1143        assert!(
1144            err.to_string().contains("sometimes"),
1145            "error should name the bad policy: {err}"
1146        );
1147    }
1148
1149    #[test]
1150    fn deserialize_json_used_class_members_supports_strings_and_scoped_rules() {
1151        let json = r#"{
1152            "usedClassMembers": [
1153                "agInit",
1154                { "implements": "ICellRendererAngularComp", "members": ["refresh"] },
1155                { "extends": "BaseCommand", "implements": "CanActivate", "members": ["execute"] }
1156            ]
1157        }"#;
1158        let config: FallowConfig = serde_json::from_str(json).unwrap();
1159        assert_eq!(
1160            config.used_class_members,
1161            vec![
1162                UsedClassMemberRule::from("agInit"),
1163                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1164                    extends: None,
1165                    implements: Some("ICellRendererAngularComp".to_string()),
1166                    members: vec!["refresh".to_string()],
1167                }),
1168                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1169                    extends: Some("BaseCommand".to_string()),
1170                    implements: Some("CanActivate".to_string()),
1171                    members: vec!["execute".to_string()],
1172                }),
1173            ]
1174        );
1175    }
1176
1177    #[test]
1178    fn deserialize_toml_minimal() {
1179        let toml_str = r#"
1180entry = ["src/index.ts"]
1181production = true
1182"#;
1183        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1184        assert_eq!(config.entry, vec!["src/index.ts"]);
1185        assert!(config.production);
1186    }
1187
1188    #[test]
1189    fn workspaces_packages_key_is_accepted_as_patterns_alias() {
1190        // An older `fallow init --toml` wrote `[workspaces]` with a `packages`
1191        // key; the back-compat serde alias keeps those existing configs scoping
1192        // instead of silently dropping the (unknown) key and losing the patterns.
1193        let config: FallowConfig =
1194            toml::from_str("[workspaces]\npackages = [\"packages/*\", \"apps/*\"]").unwrap();
1195        assert_eq!(
1196            config.workspaces.map(|w| w.patterns).unwrap_or_default(),
1197            vec!["packages/*".to_string(), "apps/*".to_string()],
1198            "the `packages` alias must populate `patterns`"
1199        );
1200    }
1201
1202    #[test]
1203    fn deserialize_toml_per_analysis_production_mode() {
1204        let toml_str = r"
1205[production]
1206deadCode = false
1207health = true
1208dupes = false
1209";
1210        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1211        assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
1212        assert!(config.production.for_analysis(ProductionAnalysis::Health));
1213        assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
1214    }
1215
1216    #[test]
1217    fn deserialize_toml_per_analysis_production_mode_rejects_unknown_fields() {
1218        let err = toml::from_str::<FallowConfig>(
1219            r"
1220[production]
1221healthTypo = true
1222",
1223        )
1224        .unwrap_err();
1225        assert!(
1226            err.to_string().contains("healthTypo"),
1227            "error should name the unknown field: {err}"
1228        );
1229    }
1230
1231    #[test]
1232    fn deserialize_toml_with_inline_framework() {
1233        let toml_str = r#"
1234[[framework]]
1235name = "my-framework"
1236enablers = ["my-framework-pkg"]
1237entryPoints = ["src/routes/**/*.tsx"]
1238"#;
1239        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1240        assert_eq!(config.framework.len(), 1);
1241        assert_eq!(config.framework[0].name, "my-framework");
1242        assert_eq!(config.framework[0].enablers, vec!["my-framework-pkg"]);
1243        assert_eq!(
1244            config.framework[0].entry_points,
1245            vec!["src/routes/**/*.tsx"]
1246        );
1247    }
1248
1249    #[test]
1250    fn deserialize_toml_fix_catalog_delete_preceding_comments() {
1251        let toml_str = r#"
1252[fix.catalog]
1253deletePrecedingComments = "never"
1254"#;
1255        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1256        assert_eq!(
1257            config.fix.catalog.delete_preceding_comments,
1258            CatalogPrecedingCommentPolicy::Never
1259        );
1260    }
1261
1262    #[test]
1263    fn deserialize_toml_with_workspace_config() {
1264        let toml_str = r#"
1265[workspaces]
1266patterns = ["packages/*", "apps/*"]
1267[workspaces.changedSince]
1268"packages/web" = "main"
1269"packages/legacy" = "release/2024.10"
1270"#;
1271        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1272        assert!(config.workspaces.is_some());
1273        let ws = config.workspaces.unwrap();
1274        assert_eq!(ws.patterns, vec!["packages/*", "apps/*"]);
1275        assert_eq!(ws.changed_since["packages/web"], "main");
1276        assert_eq!(ws.changed_since["packages/legacy"], "release/2024.10");
1277    }
1278
1279    #[test]
1280    fn deserialize_toml_with_ignore_exports() {
1281        let toml_str = r#"
1282[[ignoreExports]]
1283file = "src/types/**/*.ts"
1284exports = ["*"]
1285"#;
1286        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1287        assert_eq!(config.ignore_exports.len(), 1);
1288        assert_eq!(config.ignore_exports[0].file, "src/types/**/*.ts");
1289        assert_eq!(config.ignore_exports[0].exports, vec!["*"]);
1290    }
1291
1292    #[test]
1293    fn deserialize_toml_used_class_members_supports_scoped_rules() {
1294        let toml_str = r#"
1295usedClassMembers = [
1296  { implements = "ICellRendererAngularComp", members = ["refresh"] },
1297  { extends = "BaseCommand", members = ["execute"] },
1298]
1299"#;
1300        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1301        assert_eq!(
1302            config.used_class_members,
1303            vec![
1304                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1305                    extends: None,
1306                    implements: Some("ICellRendererAngularComp".to_string()),
1307                    members: vec!["refresh".to_string()],
1308                }),
1309                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1310                    extends: Some("BaseCommand".to_string()),
1311                    implements: None,
1312                    members: vec!["execute".to_string()],
1313                }),
1314            ]
1315        );
1316    }
1317
1318    #[test]
1319    fn deserialize_json_used_class_members_rejects_unconstrained_scoped_rules() {
1320        let result = serde_json::from_str::<FallowConfig>(
1321            r#"{"usedClassMembers":[{"members":["refresh"]}]}"#,
1322        );
1323        assert!(
1324            result.is_err(),
1325            "unconstrained scoped rule should be rejected"
1326        );
1327    }
1328
1329    #[test]
1330    fn deserialize_ignore_exports_used_in_file_bool() {
1331        let config: FallowConfig =
1332            serde_json::from_str(r#"{"ignoreExportsUsedInFile":true}"#).unwrap();
1333
1334        assert!(config.ignore_exports_used_in_file.suppresses(false));
1335        assert!(config.ignore_exports_used_in_file.suppresses(true));
1336    }
1337
1338    #[test]
1339    fn deserialize_ignore_exports_used_in_file_kind_form() {
1340        let config: FallowConfig =
1341            serde_json::from_str(r#"{"ignoreExportsUsedInFile":{"type":true}}"#).unwrap();
1342
1343        assert!(!config.ignore_exports_used_in_file.suppresses(false));
1344        assert!(config.ignore_exports_used_in_file.suppresses(true));
1345    }
1346
1347    #[test]
1348    fn deserialize_toml_deny_unknown_fields() {
1349        let toml_str = r"bogus_field = true";
1350        let result: Result<FallowConfig, _> = toml::from_str(toml_str);
1351        assert!(result.is_err(), "unknown fields should be rejected");
1352    }
1353
1354    #[test]
1355    fn json_serialize_roundtrip() {
1356        let config = FallowConfig {
1357            entry: vec!["src/main.ts".to_string()],
1358            production: true.into(),
1359            ..FallowConfig::default()
1360        };
1361        let json = serde_json::to_string(&config).unwrap();
1362        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1363        assert_eq!(restored.entry, vec!["src/main.ts"]);
1364        assert!(restored.production);
1365    }
1366
1367    #[test]
1368    fn schema_field_not_serialized() {
1369        let config = FallowConfig {
1370            schema: Some("https://example.com/schema.json".to_string()),
1371            ..FallowConfig::default()
1372        };
1373        let json = serde_json::to_string(&config).unwrap();
1374        assert!(
1375            !json.contains("$schema"),
1376            "schema field should be skipped in serialization"
1377        );
1378    }
1379
1380    #[test]
1381    fn extends_field_not_serialized() {
1382        let config = FallowConfig {
1383            extends: vec!["base.json".to_string()],
1384            ..FallowConfig::default()
1385        };
1386        let json = serde_json::to_string(&config).unwrap();
1387        assert!(
1388            !json.contains("extends"),
1389            "extends field should be skipped in serialization"
1390        );
1391    }
1392
1393    #[test]
1394    fn regression_config_deserialize_json() {
1395        let json = r#"{
1396            "regression": {
1397                "baseline": {
1398                    "totalIssues": 42,
1399                    "unusedFiles": 10,
1400                    "unusedExports": 5,
1401                    "circularDependencies": 2
1402                }
1403            }
1404        }"#;
1405        let config: FallowConfig = serde_json::from_str(json).unwrap();
1406        let regression = config.regression.unwrap();
1407        let baseline = regression.baseline.unwrap();
1408        assert_eq!(baseline.total_issues, 42);
1409        assert_eq!(baseline.unused_files, 10);
1410        assert_eq!(baseline.unused_exports, 5);
1411        assert_eq!(baseline.circular_dependencies, 2);
1412        assert_eq!(baseline.unused_types, 0);
1413        assert_eq!(baseline.boundary_violations, 0);
1414    }
1415
1416    #[test]
1417    fn regression_config_defaults_to_none() {
1418        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1419        assert!(config.regression.is_none());
1420    }
1421
1422    #[test]
1423    fn regression_baseline_all_zeros_by_default() {
1424        let baseline = RegressionBaseline::default();
1425        assert_eq!(baseline.total_issues, 0);
1426        assert_eq!(baseline.unused_files, 0);
1427        assert_eq!(baseline.unused_exports, 0);
1428        assert_eq!(baseline.unused_types, 0);
1429        assert_eq!(baseline.unused_dependencies, 0);
1430        assert_eq!(baseline.unused_dev_dependencies, 0);
1431        assert_eq!(baseline.unused_optional_dependencies, 0);
1432        assert_eq!(baseline.unused_enum_members, 0);
1433        assert_eq!(baseline.unused_class_members, 0);
1434        assert_eq!(baseline.unresolved_imports, 0);
1435        assert_eq!(baseline.unlisted_dependencies, 0);
1436        assert_eq!(baseline.duplicate_exports, 0);
1437        assert_eq!(baseline.circular_dependencies, 0);
1438        assert_eq!(baseline.type_only_dependencies, 0);
1439        assert_eq!(baseline.test_only_dependencies, 0);
1440        assert_eq!(baseline.boundary_violations, 0);
1441    }
1442
1443    #[test]
1444    fn regression_config_serialize_roundtrip() {
1445        let baseline = RegressionBaseline {
1446            total_issues: 100,
1447            unused_files: 20,
1448            unused_exports: 30,
1449            ..RegressionBaseline::default()
1450        };
1451        let regression = RegressionConfig {
1452            baseline: Some(baseline),
1453        };
1454        let config = FallowConfig {
1455            regression: Some(regression),
1456            ..FallowConfig::default()
1457        };
1458        let json = serde_json::to_string(&config).unwrap();
1459        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1460        let restored_baseline = restored.regression.unwrap().baseline.unwrap();
1461        assert_eq!(restored_baseline.total_issues, 100);
1462        assert_eq!(restored_baseline.unused_files, 20);
1463        assert_eq!(restored_baseline.unused_exports, 30);
1464        assert_eq!(restored_baseline.unused_types, 0);
1465    }
1466
1467    #[test]
1468    fn regression_config_empty_baseline_deserialize() {
1469        let json = r#"{"regression": {}}"#;
1470        let config: FallowConfig = serde_json::from_str(json).unwrap();
1471        let regression = config.regression.unwrap();
1472        assert!(regression.baseline.is_none());
1473    }
1474
1475    #[test]
1476    fn regression_baseline_not_serialized_when_none() {
1477        let config = FallowConfig {
1478            regression: None,
1479            ..FallowConfig::default()
1480        };
1481        let json = serde_json::to_string(&config).unwrap();
1482        assert!(
1483            !json.contains("regression"),
1484            "regression should be skipped when None"
1485        );
1486    }
1487
1488    #[test]
1489    fn deserialize_json_with_overrides() {
1490        let json = r#"{
1491            "overrides": [
1492                {
1493                    "files": ["*.test.ts", "*.spec.ts"],
1494                    "rules": {
1495                        "unused-exports": "off",
1496                        "unused-files": "warn"
1497                    }
1498                }
1499            ]
1500        }"#;
1501        let config: FallowConfig = serde_json::from_str(json).unwrap();
1502        assert_eq!(config.overrides.len(), 1);
1503        assert_eq!(config.overrides[0].files.len(), 2);
1504        assert_eq!(
1505            config.overrides[0].rules.unused_exports,
1506            Some(Severity::Off)
1507        );
1508        assert_eq!(config.overrides[0].rules.unused_files, Some(Severity::Warn));
1509    }
1510
1511    #[test]
1512    fn deserialize_json_with_boundaries() {
1513        let json = r#"{
1514            "boundaries": {
1515                "preset": "layered"
1516            }
1517        }"#;
1518        let config: FallowConfig = serde_json::from_str(json).unwrap();
1519        assert_eq!(config.boundaries.preset, Some(BoundaryPreset::Layered));
1520    }
1521
1522    #[test]
1523    fn deserialize_toml_with_regression_baseline() {
1524        let toml_str = r"
1525[regression.baseline]
1526totalIssues = 50
1527unusedFiles = 10
1528unusedExports = 15
1529";
1530        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1531        let baseline = config.regression.unwrap().baseline.unwrap();
1532        assert_eq!(baseline.total_issues, 50);
1533        assert_eq!(baseline.unused_files, 10);
1534        assert_eq!(baseline.unused_exports, 15);
1535    }
1536
1537    #[test]
1538    fn deserialize_toml_with_overrides() {
1539        let toml_str = r#"
1540[[overrides]]
1541files = ["*.test.ts"]
1542
1543[overrides.rules]
1544unused-exports = "off"
1545
1546[[overrides]]
1547files = ["*.stories.tsx"]
1548
1549[overrides.rules]
1550unused-files = "off"
1551"#;
1552        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1553        assert_eq!(config.overrides.len(), 2);
1554        assert_eq!(
1555            config.overrides[0].rules.unused_exports,
1556            Some(Severity::Off)
1557        );
1558        assert_eq!(config.overrides[1].rules.unused_files, Some(Severity::Off));
1559    }
1560
1561    #[test]
1562    fn regression_config_default_is_none_baseline() {
1563        let config = RegressionConfig::default();
1564        assert!(config.baseline.is_none());
1565    }
1566
1567    #[test]
1568    fn deserialize_json_multiple_ignore_export_rules() {
1569        let json = r#"{
1570            "ignoreExports": [
1571                {"file": "src/types/**/*.ts", "exports": ["*"]},
1572                {"file": "src/constants.ts", "exports": ["FOO", "BAR"]},
1573                {"file": "src/index.ts", "exports": ["default"]}
1574            ]
1575        }"#;
1576        let config: FallowConfig = serde_json::from_str(json).unwrap();
1577        assert_eq!(config.ignore_exports.len(), 3);
1578        assert_eq!(config.ignore_exports[2].exports, vec!["default"]);
1579    }
1580
1581    #[test]
1582    fn deserialize_json_public_packages_camel_case() {
1583        let json = r#"{"publicPackages": ["@myorg/shared-lib", "@myorg/utils"]}"#;
1584        let config: FallowConfig = serde_json::from_str(json).unwrap();
1585        assert_eq!(
1586            config.public_packages,
1587            vec!["@myorg/shared-lib", "@myorg/utils"]
1588        );
1589    }
1590
1591    #[test]
1592    fn deserialize_json_public_packages_rejects_snake_case() {
1593        let json = r#"{"public_packages": ["@myorg/shared-lib"]}"#;
1594        let result: Result<FallowConfig, _> = serde_json::from_str(json);
1595        assert!(
1596            result.is_err(),
1597            "snake_case should be rejected by deny_unknown_fields + rename_all camelCase"
1598        );
1599    }
1600
1601    #[test]
1602    fn deserialize_json_public_packages_empty() {
1603        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1604        assert!(config.public_packages.is_empty());
1605    }
1606
1607    #[test]
1608    fn deserialize_toml_public_packages() {
1609        let toml_str = r#"
1610publicPackages = ["@myorg/shared-lib", "@myorg/ui"]
1611"#;
1612        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1613        assert_eq!(
1614            config.public_packages,
1615            vec!["@myorg/shared-lib", "@myorg/ui"]
1616        );
1617    }
1618
1619    #[test]
1620    fn public_packages_serialize_roundtrip() {
1621        let config = FallowConfig {
1622            public_packages: vec!["@myorg/shared-lib".to_string()],
1623            ..FallowConfig::default()
1624        };
1625        let json = serde_json::to_string(&config).unwrap();
1626        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1627        assert_eq!(restored.public_packages, vec!["@myorg/shared-lib"]);
1628    }
1629}