Skip to main content

fallow_config/config/
mod.rs

1mod boundaries;
2mod duplicates_config;
3mod finding_ignore;
4mod flags;
5mod format;
6pub mod glob_validation;
7mod health;
8mod parsing;
9mod resolution;
10mod resolve;
11mod rules;
12mod used_class_members;
13
14#[expect(
15    clippy::redundant_pub_crate,
16    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"
17)]
18pub(crate) use boundaries::wildcard_placement_error;
19pub use boundaries::{
20    AuthoredRule, BoundaryCallsConfig, BoundaryConfig, BoundaryCoverageConfig, BoundaryPreset,
21    BoundaryRule, BoundaryZone, ForbiddenCallRule, ForbiddenCallee, InvalidForbiddenCallee,
22    LogicalGroup, LogicalGroupStatus, RedundantRootPrefix, ResolvedBoundaryConfig,
23    ResolvedBoundaryCoverageConfig, ResolvedBoundaryRule, ResolvedZone, UnknownZoneRef,
24    ZoneReferenceKind, ZoneValidationError,
25};
26pub use duplicates_config::{
27    DetectionMode, DuplicatesConfig, NormalizationConfig, ResolvedNormalization,
28};
29pub use finding_ignore::FindingIgnoreMatcher;
30pub use flags::{FlagsConfig, SdkPattern};
31pub use format::OutputFormat;
32pub use health::{EmailMode, HealthConfig, HealthThresholdOverride, OwnershipConfig};
33pub use parsing::ConfigLoadOptions;
34pub use resolution::{
35    AnalysisSnapshot, CompiledIgnoreCatalogReferenceRule, CompiledIgnoreDependencyOverrideRule,
36    CompiledIgnoreExportRule, ConfigOverride, DEFAULT_MAX_FILE_SIZE_BYTES,
37    DEFAULT_MAX_FILE_SIZE_MB, IgnoreCatalogReferenceRule, IgnoreDependencyOverrideRule,
38    IgnoreExportRule, ResolvedConfig, ResolvedOverride, resolve_max_file_size_bytes,
39};
40pub use resolve::ResolveConfig;
41pub use rules::{
42    KNOWN_RULE_NAMES, PartialRulesConfig, RulesConfig, Severity, closest_known_rule_name,
43    default_severity_for_kind, is_opt_in_kind,
44};
45pub use used_class_members::{ScopedUsedClassMemberRule, UsedClassMemberRule};
46
47use schemars::JsonSchema;
48use serde::{Deserialize, Deserializer, Serialize};
49use std::ops::Not;
50use std::path::PathBuf;
51
52use crate::external_plugin::ExternalPluginDef;
53use crate::workspace::WorkspaceConfig;
54
55#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
56#[serde(untagged, rename_all = "camelCase")]
57pub enum IgnoreExportsUsedInFileConfig {
58    Bool(bool),
59    ByKind(IgnoreExportsUsedInFileByKind),
60}
61
62impl Default for IgnoreExportsUsedInFileConfig {
63    fn default() -> Self {
64        Self::Bool(false)
65    }
66}
67
68impl From<bool> for IgnoreExportsUsedInFileConfig {
69    fn from(value: bool) -> Self {
70        Self::Bool(value)
71    }
72}
73
74impl From<IgnoreExportsUsedInFileByKind> for IgnoreExportsUsedInFileConfig {
75    fn from(value: IgnoreExportsUsedInFileByKind) -> Self {
76        Self::ByKind(value)
77    }
78}
79
80impl IgnoreExportsUsedInFileConfig {
81    #[must_use]
82    pub const fn is_enabled(self) -> bool {
83        match self {
84            Self::Bool(value) => value,
85            Self::ByKind(kind) => kind.type_ || kind.interface,
86        }
87    }
88
89    #[must_use]
90    pub const fn suppresses(self, is_type_only: bool) -> bool {
91        match self {
92            Self::Bool(value) => value,
93            Self::ByKind(kind) => is_type_only && (kind.type_ || kind.interface),
94        }
95    }
96}
97
98#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
99#[serde(rename_all = "camelCase")]
100pub struct IgnoreExportsUsedInFileByKind {
101    /// 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.
102    #[serde(default, rename = "type")]
103    pub type_: bool,
104    /// 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.
105    #[serde(default)]
106    pub interface: bool,
107}
108
109/// Options for the `unused-component-props` rule.
110///
111/// Lets a project exempt component props whose local destructure binding name
112/// matches a regex from `unused-component-props`, honoring the
113/// "accepted-but-intentionally-unused" leading-underscore convention (Svelte 5
114/// `$props()`, React destructure) that mirrors TypeScript `noUnusedParameters`
115/// and ESLint `@typescript-eslint/no-unused-vars` `varsIgnorePattern` /
116/// `argsIgnorePattern`. Opt-in; an unset `ignorePattern` leaves the rule's
117/// behavior unchanged.
118#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
119#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
120pub struct UnusedComponentPropsConfig {
121    /// Regex matched against each declared prop's LOCAL destructure binding name
122    /// (e.g. `_stage` in `let { stage: _stage } = $props()`), which falls back
123    /// to the public prop name when there is no alias. A prop whose local name
124    /// matches is treated as intentionally unused and never reported as
125    /// `unused-component-props`. Matching is unanchored (substring), like
126    /// ESLint's `RegExp.test`, so anchor with `^_` to match a leading
127    /// underscore. Compiled and validated at config load (an invalid regex fails
128    /// load). Applies to Vue, Svelte, Astro, and React/Preact props.
129    #[serde(default, skip_serializing_if = "Option::is_none")]
130    pub ignore_pattern: Option<String>,
131}
132
133impl UnusedComponentPropsConfig {
134    #[must_use]
135    pub fn is_default(&self) -> bool {
136        self.ignore_pattern.is_none()
137    }
138}
139
140#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
141#[serde(rename_all = "camelCase")]
142pub struct FixConfig {
143    /// 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.
144    #[serde(default)]
145    pub catalog: CatalogFixConfig,
146}
147
148#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
149#[serde(rename_all = "camelCase")]
150pub struct CatalogFixConfig {
151    /// 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.
152    #[serde(default)]
153    pub delete_preceding_comments: CatalogPrecedingCommentPolicy,
154}
155
156#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
157#[serde(rename_all = "lowercase")]
158pub enum CatalogPrecedingCommentPolicy {
159    #[default]
160    Auto,
161    Always,
162    Never,
163}
164
165/// Completeness policy for opt-in TypeScript semantic analysis.
166#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
167#[serde(rename_all = "kebab-case")]
168pub enum TypeAwareRequire {
169    /// Keep conservative findings and report semantic gaps without failing.
170    #[default]
171    BestEffort,
172    /// Fail the quality gate when any requested semantic query is incomplete.
173    Complete,
174}
175
176impl From<TypeAwareRequire> for fallow_types::semantic::SemanticCompletenessRequirement {
177    fn from(value: TypeAwareRequire) -> Self {
178        match value {
179            TypeAwareRequire::BestEffort => Self::BestEffort,
180            TypeAwareRequire::Complete => Self::Complete,
181        }
182    }
183}
184
185/// Shared opt-in configuration for TypeScript semantic analysis.
186#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
187#[serde(deny_unknown_fields, rename_all = "camelCase")]
188pub struct TypeAwareConfig {
189    /// Enable the optional TypeScript semantic pass. Disabled by default.
190    #[serde(default)]
191    pub enabled: bool,
192    /// TypeScript project config paths, resolved relative to the project root.
193    #[serde(default, skip_serializing_if = "Vec::is_empty")]
194    pub projects: Vec<String>,
195    /// Decide whether partial semantic analysis is advisory or gating.
196    #[serde(default, skip_serializing_if = "is_default_type_aware_require")]
197    pub require: TypeAwareRequire,
198}
199
200#[expect(
201    clippy::trivially_copy_pass_by_ref,
202    reason = "serde skip_serializing_if callbacks receive field values by reference"
203)]
204fn is_default_type_aware_require(value: &TypeAwareRequire) -> bool {
205    matches!(value, TypeAwareRequire::BestEffort)
206}
207
208impl TypeAwareConfig {
209    #[must_use]
210    pub fn is_default(&self) -> bool {
211        !self.enabled && self.projects.is_empty() && self.require == TypeAwareRequire::BestEffort
212    }
213}
214
215#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
216#[serde(deny_unknown_fields, rename_all = "camelCase")]
217pub struct FallowConfig {
218    /// 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.
219    #[serde(rename = "$schema", default, skip_serializing)]
220    pub schema: Option<String>,
221
222    /// An ordered array of parent config sources to inherit before this file's own keys apply; each entry 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).
223    #[serde(default, skip_serializing)]
224    pub extends: Vec<String>,
225
226    /// 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.
227    #[serde(default)]
228    pub entry: Vec<String>,
229
230    /// 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.
231    #[serde(default)]
232    pub ignore_patterns: Vec<String>,
233
234    /// 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.
235    #[serde(default, skip_serializing_if = "Vec::is_empty")]
236    pub ignore_findings: Vec<String>,
237
238    /// 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.
239    #[serde(default)]
240    pub framework: Vec<ExternalPluginDef>,
241
242    /// Monorepo workspace configuration whose sole sub-key patterns (array of globs) adds workspace package roots beyond those discovered from package.json workspaces, pnpm-workspace.yaml, and tsconfig references. Optional and absent by default (discovery uses the manifests alone); set it only when workspaces live in directories the standard manifests do not declare.
243    #[serde(default)]
244    pub workspaces: Option<WorkspaceConfig>,
245
246    /// A list of exact package names 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; matching is exact string equality against the package name, not a glob.
247    #[serde(default)]
248    pub ignore_dependencies: Vec<String>,
249
250    /// 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.
251    #[serde(default)]
252    pub ignore_unresolved_imports: Vec<String>,
253
254    /// 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.
255    #[serde(default)]
256    pub ignore_exports: Vec<IgnoreExportRule>,
257
258    /// 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.
259    #[serde(default, skip_serializing_if = "Vec::is_empty")]
260    pub ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>,
261
262    /// 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"`.
263    #[serde(default, skip_serializing_if = "Vec::is_empty")]
264    pub ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>,
265
266    /// 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.
267    #[serde(default)]
268    pub ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig,
269
270    /// 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.
271    #[serde(default, skip_serializing_if = "Vec::is_empty")]
272    pub ignore_decorators: Vec<String>,
273
274    /// 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.
275    #[serde(default)]
276    pub used_class_members: Vec<UsedClassMemberRule>,
277
278    /// 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), `minTokens` (50), `minLines` (5), `minOccurrences` (integer >= 2, deserialization fails below 2), `threshold` (max duplication percentage, 0 = no limit), `ignore` globs, `ignoreDefaults` (true, merge built-in generated-file ignores), `skipLocal` (only report cross-directory clones), `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, or set `mode` to `semantic` to catch renamed-variable clones.
279    #[serde(default)]
280    pub duplicates: DuplicatesConfig,
281
282    /// 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.
283    #[serde(default)]
284    pub health: HealthConfig,
285
286    /// Opts into TypeScript semantic analysis for project-wide symbol use,
287    /// provenance, API surface, symbol impact, and public-signature coupling.
288    /// This does not surface compiler diagnostics or typed lint rules.
289    #[serde(default, skip_serializing_if = "TypeAwareConfig::is_default")]
290    pub type_aware: TypeAwareConfig,
291
292    /// 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`, `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.
293    #[serde(default)]
294    pub rules: RulesConfig,
295
296    #[serde(
297        default,
298        skip_serializing_if = "UnusedComponentPropsConfig::is_default"
299    )]
300    /// 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).
301    pub unused_component_props: UnusedComponentPropsConfig,
302
303    /// 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).
304    #[serde(default)]
305    pub boundaries: BoundaryConfig,
306
307    /// 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.*` 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`).
308    #[serde(default)]
309    pub flags: FlagsConfig,
310
311    /// 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.
312    #[serde(default)]
313    pub security: SecurityConfig,
314
315    /// 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.
316    #[serde(default)]
317    pub fix: FixConfig,
318
319    /// 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.
320    #[serde(default)]
321    pub resolve: ResolveConfig,
322
323    /// 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).
324    #[serde(default)]
325    pub production: ProductionConfig,
326
327    /// 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).
328    #[serde(default)]
329    pub plugins: Vec<String>,
330
331    /// Paths to declarative rule-pack files (JSON or JSONC), relative to the
332    /// project root. Each pack declares `banned-call`, `banned-import`, or
333    /// `banned-effect` rules that report as `policy-violation` findings. Packs
334    /// are pure data: no project code is executed. Invalid or missing packs
335    /// fail config load.
336    #[serde(default, skip_serializing_if = "Vec::is_empty")]
337    pub rule_packs: Vec<String>,
338
339    /// 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.
340    #[serde(default)]
341    pub dynamically_loaded: Vec<String>,
342
343    /// 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).
344    #[serde(default)]
345    pub overrides: Vec<ConfigOverride>,
346
347    /// 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.
348    #[serde(default, skip_serializing_if = "Option::is_none")]
349    pub codeowners: Option<String>,
350
351    /// 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).
352    #[serde(default)]
353    pub public_packages: Vec<String>,
354
355    /// 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.
356    #[serde(default, skip_serializing_if = "Option::is_none")]
357    pub regression: Option<RegressionConfig>,
358
359    /// 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.
360    #[serde(default, skip_serializing_if = "AuditConfig::is_empty")]
361    pub audit: AuditConfig,
362
363    /// 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.
364    #[serde(default)]
365    pub sealed: bool,
366
367    /// 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.
368    #[serde(default)]
369    pub include_entry_exports: bool,
370
371    /// When true, drops Nuxt convention-based entry-pattern fallbacks: component fallbacks are dropped unless nuxt.config declares components:, and composable/util fallbacks are dropped unless it declares imports:, so genuinely-unreferenced convention files surface as unused-file. 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.
372    #[serde(default)]
373    pub auto_imports: bool,
374
375    /// 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`.
376    #[serde(default, skip_serializing_if = "CacheConfig::is_default")]
377    pub cache: CacheConfig,
378}
379
380/// Scopes `fallow security` catalogue behavior. An absent category block admits
381/// every catalogue category. `hardcoded-secret` is include-required and only
382/// runs when explicitly listed in `security.categories.include`.
383#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
384#[serde(deny_unknown_fields, rename_all = "camelCase")]
385pub struct SecurityConfig {
386    /// Include/exclude filter over category ids (e.g. `dangerous-html`).
387    #[serde(default, skip_serializing_if = "Option::is_none")]
388    pub categories: Option<SecurityCategories>,
389    /// Additional project-local names for HTTP request objects. These names
390    /// extend the built-in receiver allowlist for `*.query`, `*.params`, and
391    /// `*.body` source patterns. They do not replace the built-ins and do not
392    /// gate `*.searchParams`, which intentionally stays ungated.
393    #[serde(default, skip_serializing_if = "Vec::is_empty")]
394    pub request_receivers: Vec<String>,
395}
396
397impl SecurityConfig {
398    #[must_use]
399    pub fn normalized_request_receivers(&self) -> Vec<String> {
400        let mut receivers = Vec::new();
401        for receiver in &self.request_receivers {
402            let normalized = receiver.trim().to_ascii_lowercase();
403            if !normalized.is_empty() && !receivers.contains(&normalized) {
404                receivers.push(normalized);
405            }
406        }
407        receivers
408    }
409
410    #[must_use]
411    pub fn request_receivers_are_valid(&self) -> bool {
412        self.request_receivers
413            .iter()
414            .all(|receiver| !receiver.trim().is_empty())
415    }
416}
417
418/// Include/exclude lists scoping the active security categories. When `include`
419/// is set, only those categories are active; `exclude` removes categories from
420/// the admitted set. Both unset admits catalogue categories. `hardcoded-secret`
421/// still requires explicit inclusion.
422#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
423#[serde(deny_unknown_fields, rename_all = "camelCase")]
424pub struct SecurityCategories {
425    /// Catalogue category ids to admit. When set, all others are excluded.
426    #[serde(default, skip_serializing_if = "Option::is_none")]
427    pub include: Option<Vec<String>>,
428    /// Catalogue category ids to remove from the admitted set.
429    #[serde(default, skip_serializing_if = "Option::is_none")]
430    pub exclude: Option<Vec<String>>,
431}
432
433#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
434#[serde(deny_unknown_fields, rename_all = "camelCase")]
435pub struct CacheConfig {
436    /// Directory for fallow's persistent analysis cache. Relative paths resolve
437    /// from the project root.
438    #[serde(default, skip_serializing_if = "Option::is_none")]
439    pub dir: Option<PathBuf>,
440    /// Maximum size of the persistent extraction cache, in megabytes.
441    #[serde(default, skip_serializing_if = "Option::is_none")]
442    pub max_size_mb: Option<u32>,
443}
444
445impl CacheConfig {
446    #[must_use]
447    pub fn is_default(&self) -> bool {
448        self.dir.is_none() && self.max_size_mb.is_none()
449    }
450}
451
452#[derive(Debug, Clone, Copy, PartialEq, Eq)]
453pub enum ProductionAnalysis {
454    DeadCode,
455    Health,
456    Dupes,
457}
458
459#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, JsonSchema)]
460#[serde(untagged)]
461pub enum ProductionConfig {
462    Global(bool),
463    PerAnalysis(PerAnalysisProductionConfig),
464}
465
466impl<'de> Deserialize<'de> for ProductionConfig {
467    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
468    where
469        D: Deserializer<'de>,
470    {
471        struct ProductionConfigVisitor;
472
473        impl<'de> serde::de::Visitor<'de> for ProductionConfigVisitor {
474            type Value = ProductionConfig;
475
476            fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
477                formatter.write_str("a boolean or per-analysis production config object")
478            }
479
480            fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
481            where
482                E: serde::de::Error,
483            {
484                Ok(ProductionConfig::Global(value))
485            }
486
487            fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
488            where
489                A: serde::de::MapAccess<'de>,
490            {
491                PerAnalysisProductionConfig::deserialize(
492                    serde::de::value::MapAccessDeserializer::new(map),
493                )
494                .map(ProductionConfig::PerAnalysis)
495            }
496        }
497
498        deserializer.deserialize_any(ProductionConfigVisitor)
499    }
500}
501
502impl Default for ProductionConfig {
503    fn default() -> Self {
504        Self::Global(false)
505    }
506}
507
508impl From<bool> for ProductionConfig {
509    fn from(value: bool) -> Self {
510        Self::Global(value)
511    }
512}
513
514impl Not for ProductionConfig {
515    type Output = bool;
516
517    fn not(self) -> Self::Output {
518        !self.any_enabled()
519    }
520}
521
522impl ProductionConfig {
523    #[must_use]
524    pub const fn for_analysis(self, analysis: ProductionAnalysis) -> bool {
525        match self {
526            Self::Global(value) => value,
527            Self::PerAnalysis(config) => match analysis {
528                ProductionAnalysis::DeadCode => config.dead_code,
529                ProductionAnalysis::Health => config.health,
530                ProductionAnalysis::Dupes => config.dupes,
531            },
532        }
533    }
534
535    #[must_use]
536    pub const fn global(self) -> bool {
537        match self {
538            Self::Global(value) => value,
539            Self::PerAnalysis(_) => false,
540        }
541    }
542
543    #[must_use]
544    pub const fn any_enabled(self) -> bool {
545        match self {
546            Self::Global(value) => value,
547            Self::PerAnalysis(config) => config.dead_code || config.health || config.dupes,
548        }
549    }
550}
551
552#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
553#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
554pub struct PerAnalysisProductionConfig {
555    /// 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.
556    pub dead_code: bool,
557    /// 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.
558    pub health: bool,
559    /// 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.
560    pub dupes: bool,
561}
562
563#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
564#[serde(rename_all = "camelCase")]
565pub struct AuditConfig {
566    /// 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.
567    #[serde(default, skip_serializing_if = "AuditGate::is_default")]
568    pub gate: AuditGate,
569
570    /// 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.
571    #[serde(default, skip_serializing_if = "Option::is_none")]
572    pub css: Option<bool>,
573
574    /// 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.
575    #[serde(default, skip_serializing_if = "Option::is_none")]
576    pub css_deep: Option<bool>,
577
578    /// 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`.
579    #[serde(default, skip_serializing_if = "Option::is_none")]
580    pub dead_code_baseline: Option<String>,
581
582    /// 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.
583    #[serde(default, skip_serializing_if = "Option::is_none")]
584    pub health_baseline: Option<String>,
585
586    /// 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.
587    #[serde(default, skip_serializing_if = "Option::is_none")]
588    pub dupes_baseline: Option<String>,
589
590    /// 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. The `FALLOW_AUDIT_CACHE_MAX_AGE_DAYS` environment variable overrides this field.
591    #[serde(default, skip_serializing_if = "Option::is_none")]
592    pub cache_max_age_days: Option<u32>,
593
594    /// 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.
595    #[serde(default, skip_serializing_if = "Option::is_none")]
596    pub type_aware: Option<bool>,
597}
598
599impl AuditConfig {
600    #[must_use]
601    pub fn is_empty(&self) -> bool {
602        self.gate.is_default()
603            && self.css.is_none()
604            && self.css_deep.is_none()
605            && self.dead_code_baseline.is_none()
606            && self.health_baseline.is_none()
607            && self.dupes_baseline.is_none()
608            && self.cache_max_age_days.is_none()
609            && self.type_aware.is_none()
610    }
611}
612
613#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
614#[serde(rename_all = "kebab-case")]
615pub enum AuditGate {
616    #[default]
617    NewOnly,
618    All,
619}
620
621impl AuditGate {
622    #[must_use]
623    pub const fn is_default(&self) -> bool {
624        matches!(self, Self::NewOnly)
625    }
626}
627
628#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
629#[serde(rename_all = "camelCase")]
630pub struct RegressionConfig {
631    /// 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.
632    #[serde(default, skip_serializing_if = "Option::is_none")]
633    pub baseline: Option<RegressionBaseline>,
634}
635
636#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
637#[serde(rename_all = "camelCase")]
638pub struct RegressionBaseline {
639    /// Compatibility identity for the analysis that produced these counts.
640    /// Missing values in existing configs are treated as syntactic.
641    #[serde(default)]
642    pub analysis_identity: fallow_types::semantic::SemanticAnalysisIdentity,
643    #[serde(default)]
644    pub total_issues: usize,
645    #[serde(default)]
646    pub unused_files: usize,
647    #[serde(default)]
648    pub unused_exports: usize,
649    #[serde(default)]
650    pub unused_types: usize,
651    #[serde(default)]
652    pub unused_dependencies: usize,
653    #[serde(default)]
654    pub unused_dev_dependencies: usize,
655    #[serde(default)]
656    pub unused_optional_dependencies: usize,
657    #[serde(default)]
658    pub unused_enum_members: usize,
659    #[serde(default)]
660    pub unused_class_members: usize,
661    #[serde(default)]
662    pub unresolved_imports: usize,
663    #[serde(default)]
664    pub unlisted_dependencies: usize,
665    #[serde(default)]
666    pub duplicate_exports: usize,
667    #[serde(default)]
668    pub circular_dependencies: usize,
669    #[serde(default)]
670    pub re_export_cycles: usize,
671    #[serde(default)]
672    pub type_only_dependencies: usize,
673    #[serde(default)]
674    pub test_only_dependencies: usize,
675    #[serde(default)]
676    pub dev_dependencies_in_production: usize,
677    #[serde(default)]
678    pub boundary_violations: usize,
679    #[serde(default)]
680    pub boundary_coverage_violations: usize,
681    #[serde(default)]
682    pub boundary_call_violations: usize,
683    #[serde(default)]
684    pub policy_violations: usize,
685}
686
687#[cfg(test)]
688mod tests {
689    use super::*;
690
691    #[test]
692    fn default_config_has_empty_collections() {
693        let config = FallowConfig::default();
694        assert!(config.schema.is_none());
695        assert!(config.extends.is_empty());
696        assert!(config.entry.is_empty());
697        assert!(config.ignore_patterns.is_empty());
698        assert!(config.ignore_findings.is_empty());
699        assert!(config.framework.is_empty());
700        assert!(config.workspaces.is_none());
701        assert!(config.ignore_dependencies.is_empty());
702        assert!(config.ignore_exports.is_empty());
703        assert!(config.used_class_members.is_empty());
704        assert!(config.plugins.is_empty());
705        assert!(config.dynamically_loaded.is_empty());
706        assert!(config.overrides.is_empty());
707        assert!(config.public_packages.is_empty());
708        assert_eq!(
709            config.fix.catalog.delete_preceding_comments,
710            CatalogPrecedingCommentPolicy::Auto
711        );
712        assert!(!config.production);
713    }
714
715    #[test]
716    fn default_config_rules_are_error() {
717        let config = FallowConfig::default();
718        assert_eq!(config.rules.unused_files, Severity::Error);
719        assert_eq!(config.rules.unused_exports, Severity::Error);
720        assert_eq!(config.rules.unused_dependencies, Severity::Error);
721    }
722
723    #[test]
724    fn default_config_duplicates_enabled() {
725        let config = FallowConfig::default();
726        assert!(config.duplicates.enabled);
727        assert_eq!(config.duplicates.min_tokens, 50);
728        assert_eq!(config.duplicates.min_lines, 5);
729    }
730
731    #[test]
732    fn default_config_health_thresholds() {
733        let config = FallowConfig::default();
734        assert_eq!(config.health.max_cyclomatic, 20);
735        assert_eq!(config.health.max_cognitive, 15);
736    }
737
738    #[test]
739    fn deserialize_empty_json_object() {
740        let config: FallowConfig = serde_json::from_str("{}").unwrap();
741        assert!(config.entry.is_empty());
742        assert!(!config.production);
743        assert!(!config.type_aware.enabled);
744        assert_eq!(config.type_aware.require, TypeAwareRequire::BestEffort);
745    }
746
747    #[test]
748    fn deserialize_type_aware_config() {
749        let config: FallowConfig = serde_json::from_str(
750            r#"{"typeAware":{"enabled":true,"projects":["tsconfig.app.json"],"require":"complete"}}"#,
751        )
752        .unwrap();
753
754        assert!(config.type_aware.enabled);
755        assert_eq!(config.type_aware.projects, ["tsconfig.app.json"]);
756        assert_eq!(config.type_aware.require, TypeAwareRequire::Complete);
757    }
758
759    #[test]
760    fn deserialize_type_aware_config_rejects_unknown_fields() {
761        let result = serde_json::from_str::<FallowConfig>(
762            r#"{"typeAware":{"enabled":true,"compilerDiagnostics":true}}"#,
763        );
764        assert!(result.is_err());
765    }
766
767    #[test]
768    fn deserialize_json_with_all_top_level_fields() {
769        let json = r#"{
770            "$schema": "./node_modules/fallow/schema.json",
771            "entry": ["src/main.ts"],
772            "ignorePatterns": ["generated/**"],
773            "ignoreFindings": ["**/*.test.ts", "!src/public/**"],
774            "ignoreDependencies": ["postcss"],
775            "production": true,
776            "plugins": ["custom-plugin.toml"],
777            "rules": {"unused-files": "warn"},
778            "duplicates": {"enabled": false},
779            "health": {"maxCyclomatic": 30}
780        }"#;
781        let config: FallowConfig = serde_json::from_str(json).unwrap();
782        assert_eq!(
783            config.schema.as_deref(),
784            Some("./node_modules/fallow/schema.json")
785        );
786        assert_eq!(config.entry, vec!["src/main.ts"]);
787        assert_eq!(config.ignore_patterns, vec!["generated/**"]);
788        assert_eq!(
789            config.ignore_findings,
790            vec!["**/*.test.ts", "!src/public/**"]
791        );
792        assert_eq!(config.ignore_dependencies, vec!["postcss"]);
793        assert!(config.production);
794        assert_eq!(config.plugins, vec!["custom-plugin.toml"]);
795        assert_eq!(config.rules.unused_files, Severity::Warn);
796        assert!(!config.duplicates.enabled);
797        assert_eq!(config.health.max_cyclomatic, 30);
798    }
799
800    #[test]
801    fn deserialize_json_deny_unknown_fields() {
802        let json = r#"{"unknownField": true}"#;
803        let result: Result<FallowConfig, _> = serde_json::from_str(json);
804        assert!(result.is_err(), "unknown fields should be rejected");
805    }
806
807    #[test]
808    fn ignore_findings_serialization_is_canonical_and_sparse() {
809        let default_value = serde_json::to_value(FallowConfig::default()).unwrap();
810        assert!(default_value.get("ignoreFindings").is_none());
811
812        let config = FallowConfig {
813            ignore_findings: vec!["**/*.test.ts".to_string(), "!src/public/**".to_string()],
814            ..Default::default()
815        };
816        let value = serde_json::to_value(config).unwrap();
817        assert_eq!(
818            value.get("ignoreFindings"),
819            Some(&serde_json::json!(["**/*.test.ts", "!src/public/**"]))
820        );
821    }
822
823    #[test]
824    fn ignore_findings_deserializes_from_toml() {
825        let config: FallowConfig =
826            toml::from_str(r#"ignoreFindings = ["**/*.test.ts", "!src/public/**"]"#).unwrap();
827
828        assert_eq!(
829            config.ignore_findings,
830            vec!["**/*.test.ts", "!src/public/**"]
831        );
832    }
833
834    #[test]
835    fn generic_ignore_alias_is_rejected() {
836        let result = serde_json::from_str::<FallowConfig>(r#"{"ignore": ["**/*.test.ts"]}"#);
837
838        assert!(result.is_err());
839    }
840
841    #[test]
842    fn deserialize_json_production_mode_default_false() {
843        let config: FallowConfig = serde_json::from_str("{}").unwrap();
844        assert!(!config.production);
845    }
846
847    #[test]
848    fn deserialize_json_production_mode_true() {
849        let config: FallowConfig = serde_json::from_str(r#"{"production": true}"#).unwrap();
850        assert!(config.production);
851    }
852
853    #[test]
854    fn deserialize_json_per_analysis_production_mode() {
855        let config: FallowConfig = serde_json::from_str(
856            r#"{"production": {"deadCode": false, "health": true, "dupes": false}}"#,
857        )
858        .unwrap();
859        assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
860        assert!(config.production.for_analysis(ProductionAnalysis::Health));
861        assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
862    }
863
864    #[test]
865    fn deserialize_json_per_analysis_production_mode_rejects_unknown_fields() {
866        let err = serde_json::from_str::<FallowConfig>(r#"{"production": {"healthTypo": true}}"#)
867            .unwrap_err();
868        assert!(
869            err.to_string().contains("healthTypo"),
870            "error should name the unknown field: {err}"
871        );
872    }
873
874    #[test]
875    fn deserialize_json_dynamically_loaded() {
876        let json = r#"{"dynamicallyLoaded": ["plugins/**/*.ts", "locales/**/*.json"]}"#;
877        let config: FallowConfig = serde_json::from_str(json).unwrap();
878        assert_eq!(
879            config.dynamically_loaded,
880            vec!["plugins/**/*.ts", "locales/**/*.json"]
881        );
882    }
883
884    #[test]
885    fn deserialize_json_dynamically_loaded_defaults_empty() {
886        let config: FallowConfig = serde_json::from_str("{}").unwrap();
887        assert!(config.dynamically_loaded.is_empty());
888    }
889
890    #[test]
891    fn deserialize_json_fix_catalog_delete_preceding_comments() {
892        let config: FallowConfig =
893            serde_json::from_str(r#"{"fix": {"catalog": {"deletePrecedingComments": "always"}}}"#)
894                .unwrap();
895        assert_eq!(
896            config.fix.catalog.delete_preceding_comments,
897            CatalogPrecedingCommentPolicy::Always
898        );
899    }
900
901    #[test]
902    fn deserialize_json_fix_catalog_delete_preceding_comments_rejects_unknown_policy() {
903        let err = serde_json::from_str::<FallowConfig>(
904            r#"{"fix": {"catalog": {"deletePrecedingComments": "sometimes"}}}"#,
905        )
906        .unwrap_err();
907        assert!(
908            err.to_string().contains("sometimes"),
909            "error should name the bad policy: {err}"
910        );
911    }
912
913    #[test]
914    fn deserialize_json_used_class_members_supports_strings_and_scoped_rules() {
915        let json = r#"{
916            "usedClassMembers": [
917                "agInit",
918                { "implements": "ICellRendererAngularComp", "members": ["refresh"] },
919                { "extends": "BaseCommand", "implements": "CanActivate", "members": ["execute"] }
920            ]
921        }"#;
922        let config: FallowConfig = serde_json::from_str(json).unwrap();
923        assert_eq!(
924            config.used_class_members,
925            vec![
926                UsedClassMemberRule::from("agInit"),
927                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
928                    extends: None,
929                    implements: Some("ICellRendererAngularComp".to_string()),
930                    members: vec!["refresh".to_string()],
931                }),
932                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
933                    extends: Some("BaseCommand".to_string()),
934                    implements: Some("CanActivate".to_string()),
935                    members: vec!["execute".to_string()],
936                }),
937            ]
938        );
939    }
940
941    #[test]
942    fn deserialize_toml_minimal() {
943        let toml_str = r#"
944entry = ["src/index.ts"]
945production = true
946"#;
947        let config: FallowConfig = toml::from_str(toml_str).unwrap();
948        assert_eq!(config.entry, vec!["src/index.ts"]);
949        assert!(config.production);
950    }
951
952    #[test]
953    fn workspaces_packages_key_is_accepted_as_patterns_alias() {
954        // An older `fallow init --toml` wrote `[workspaces]` with a `packages`
955        // key; the back-compat serde alias keeps those existing configs scoping
956        // instead of silently dropping the (unknown) key and losing the patterns.
957        let config: FallowConfig =
958            toml::from_str("[workspaces]\npackages = [\"packages/*\", \"apps/*\"]").unwrap();
959        assert_eq!(
960            config.workspaces.map(|w| w.patterns).unwrap_or_default(),
961            vec!["packages/*".to_string(), "apps/*".to_string()],
962            "the `packages` alias must populate `patterns`"
963        );
964    }
965
966    #[test]
967    fn deserialize_toml_per_analysis_production_mode() {
968        let toml_str = r"
969[production]
970deadCode = false
971health = true
972dupes = false
973";
974        let config: FallowConfig = toml::from_str(toml_str).unwrap();
975        assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
976        assert!(config.production.for_analysis(ProductionAnalysis::Health));
977        assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
978    }
979
980    #[test]
981    fn deserialize_toml_per_analysis_production_mode_rejects_unknown_fields() {
982        let err = toml::from_str::<FallowConfig>(
983            r"
984[production]
985healthTypo = true
986",
987        )
988        .unwrap_err();
989        assert!(
990            err.to_string().contains("healthTypo"),
991            "error should name the unknown field: {err}"
992        );
993    }
994
995    #[test]
996    fn deserialize_toml_with_inline_framework() {
997        let toml_str = r#"
998[[framework]]
999name = "my-framework"
1000enablers = ["my-framework-pkg"]
1001entryPoints = ["src/routes/**/*.tsx"]
1002"#;
1003        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1004        assert_eq!(config.framework.len(), 1);
1005        assert_eq!(config.framework[0].name, "my-framework");
1006        assert_eq!(config.framework[0].enablers, vec!["my-framework-pkg"]);
1007        assert_eq!(
1008            config.framework[0].entry_points,
1009            vec!["src/routes/**/*.tsx"]
1010        );
1011    }
1012
1013    #[test]
1014    fn deserialize_toml_fix_catalog_delete_preceding_comments() {
1015        let toml_str = r#"
1016[fix.catalog]
1017deletePrecedingComments = "never"
1018"#;
1019        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1020        assert_eq!(
1021            config.fix.catalog.delete_preceding_comments,
1022            CatalogPrecedingCommentPolicy::Never
1023        );
1024    }
1025
1026    #[test]
1027    fn deserialize_toml_with_workspace_config() {
1028        let toml_str = r#"
1029[workspaces]
1030patterns = ["packages/*", "apps/*"]
1031"#;
1032        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1033        assert!(config.workspaces.is_some());
1034        let ws = config.workspaces.unwrap();
1035        assert_eq!(ws.patterns, vec!["packages/*", "apps/*"]);
1036    }
1037
1038    #[test]
1039    fn deserialize_toml_with_ignore_exports() {
1040        let toml_str = r#"
1041[[ignoreExports]]
1042file = "src/types/**/*.ts"
1043exports = ["*"]
1044"#;
1045        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1046        assert_eq!(config.ignore_exports.len(), 1);
1047        assert_eq!(config.ignore_exports[0].file, "src/types/**/*.ts");
1048        assert_eq!(config.ignore_exports[0].exports, vec!["*"]);
1049    }
1050
1051    #[test]
1052    fn deserialize_toml_used_class_members_supports_scoped_rules() {
1053        let toml_str = r#"
1054usedClassMembers = [
1055  { implements = "ICellRendererAngularComp", members = ["refresh"] },
1056  { extends = "BaseCommand", members = ["execute"] },
1057]
1058"#;
1059        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1060        assert_eq!(
1061            config.used_class_members,
1062            vec![
1063                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1064                    extends: None,
1065                    implements: Some("ICellRendererAngularComp".to_string()),
1066                    members: vec!["refresh".to_string()],
1067                }),
1068                UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1069                    extends: Some("BaseCommand".to_string()),
1070                    implements: None,
1071                    members: vec!["execute".to_string()],
1072                }),
1073            ]
1074        );
1075    }
1076
1077    #[test]
1078    fn deserialize_json_used_class_members_rejects_unconstrained_scoped_rules() {
1079        let result = serde_json::from_str::<FallowConfig>(
1080            r#"{"usedClassMembers":[{"members":["refresh"]}]}"#,
1081        );
1082        assert!(
1083            result.is_err(),
1084            "unconstrained scoped rule should be rejected"
1085        );
1086    }
1087
1088    #[test]
1089    fn deserialize_ignore_exports_used_in_file_bool() {
1090        let config: FallowConfig =
1091            serde_json::from_str(r#"{"ignoreExportsUsedInFile":true}"#).unwrap();
1092
1093        assert!(config.ignore_exports_used_in_file.suppresses(false));
1094        assert!(config.ignore_exports_used_in_file.suppresses(true));
1095    }
1096
1097    #[test]
1098    fn deserialize_ignore_exports_used_in_file_kind_form() {
1099        let config: FallowConfig =
1100            serde_json::from_str(r#"{"ignoreExportsUsedInFile":{"type":true}}"#).unwrap();
1101
1102        assert!(!config.ignore_exports_used_in_file.suppresses(false));
1103        assert!(config.ignore_exports_used_in_file.suppresses(true));
1104    }
1105
1106    #[test]
1107    fn deserialize_toml_deny_unknown_fields() {
1108        let toml_str = r"bogus_field = true";
1109        let result: Result<FallowConfig, _> = toml::from_str(toml_str);
1110        assert!(result.is_err(), "unknown fields should be rejected");
1111    }
1112
1113    #[test]
1114    fn json_serialize_roundtrip() {
1115        let config = FallowConfig {
1116            entry: vec!["src/main.ts".to_string()],
1117            production: true.into(),
1118            ..FallowConfig::default()
1119        };
1120        let json = serde_json::to_string(&config).unwrap();
1121        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1122        assert_eq!(restored.entry, vec!["src/main.ts"]);
1123        assert!(restored.production);
1124    }
1125
1126    #[test]
1127    fn schema_field_not_serialized() {
1128        let config = FallowConfig {
1129            schema: Some("https://example.com/schema.json".to_string()),
1130            ..FallowConfig::default()
1131        };
1132        let json = serde_json::to_string(&config).unwrap();
1133        assert!(
1134            !json.contains("$schema"),
1135            "schema field should be skipped in serialization"
1136        );
1137    }
1138
1139    #[test]
1140    fn extends_field_not_serialized() {
1141        let config = FallowConfig {
1142            extends: vec!["base.json".to_string()],
1143            ..FallowConfig::default()
1144        };
1145        let json = serde_json::to_string(&config).unwrap();
1146        assert!(
1147            !json.contains("extends"),
1148            "extends field should be skipped in serialization"
1149        );
1150    }
1151
1152    #[test]
1153    fn regression_config_deserialize_json() {
1154        let json = r#"{
1155            "regression": {
1156                "baseline": {
1157                    "totalIssues": 42,
1158                    "unusedFiles": 10,
1159                    "unusedExports": 5,
1160                    "circularDependencies": 2
1161                }
1162            }
1163        }"#;
1164        let config: FallowConfig = serde_json::from_str(json).unwrap();
1165        let regression = config.regression.unwrap();
1166        let baseline = regression.baseline.unwrap();
1167        assert_eq!(baseline.total_issues, 42);
1168        assert_eq!(baseline.unused_files, 10);
1169        assert_eq!(baseline.unused_exports, 5);
1170        assert_eq!(baseline.circular_dependencies, 2);
1171        assert_eq!(baseline.unused_types, 0);
1172        assert_eq!(baseline.boundary_violations, 0);
1173    }
1174
1175    #[test]
1176    fn regression_config_defaults_to_none() {
1177        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1178        assert!(config.regression.is_none());
1179    }
1180
1181    #[test]
1182    fn regression_baseline_all_zeros_by_default() {
1183        let baseline = RegressionBaseline::default();
1184        assert_eq!(baseline.total_issues, 0);
1185        assert_eq!(baseline.unused_files, 0);
1186        assert_eq!(baseline.unused_exports, 0);
1187        assert_eq!(baseline.unused_types, 0);
1188        assert_eq!(baseline.unused_dependencies, 0);
1189        assert_eq!(baseline.unused_dev_dependencies, 0);
1190        assert_eq!(baseline.unused_optional_dependencies, 0);
1191        assert_eq!(baseline.unused_enum_members, 0);
1192        assert_eq!(baseline.unused_class_members, 0);
1193        assert_eq!(baseline.unresolved_imports, 0);
1194        assert_eq!(baseline.unlisted_dependencies, 0);
1195        assert_eq!(baseline.duplicate_exports, 0);
1196        assert_eq!(baseline.circular_dependencies, 0);
1197        assert_eq!(baseline.type_only_dependencies, 0);
1198        assert_eq!(baseline.test_only_dependencies, 0);
1199        assert_eq!(baseline.boundary_violations, 0);
1200    }
1201
1202    #[test]
1203    fn regression_config_serialize_roundtrip() {
1204        let baseline = RegressionBaseline {
1205            total_issues: 100,
1206            unused_files: 20,
1207            unused_exports: 30,
1208            ..RegressionBaseline::default()
1209        };
1210        let regression = RegressionConfig {
1211            baseline: Some(baseline),
1212        };
1213        let config = FallowConfig {
1214            regression: Some(regression),
1215            ..FallowConfig::default()
1216        };
1217        let json = serde_json::to_string(&config).unwrap();
1218        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1219        let restored_baseline = restored.regression.unwrap().baseline.unwrap();
1220        assert_eq!(restored_baseline.total_issues, 100);
1221        assert_eq!(restored_baseline.unused_files, 20);
1222        assert_eq!(restored_baseline.unused_exports, 30);
1223        assert_eq!(restored_baseline.unused_types, 0);
1224    }
1225
1226    #[test]
1227    fn regression_config_empty_baseline_deserialize() {
1228        let json = r#"{"regression": {}}"#;
1229        let config: FallowConfig = serde_json::from_str(json).unwrap();
1230        let regression = config.regression.unwrap();
1231        assert!(regression.baseline.is_none());
1232    }
1233
1234    #[test]
1235    fn regression_baseline_not_serialized_when_none() {
1236        let config = FallowConfig {
1237            regression: None,
1238            ..FallowConfig::default()
1239        };
1240        let json = serde_json::to_string(&config).unwrap();
1241        assert!(
1242            !json.contains("regression"),
1243            "regression should be skipped when None"
1244        );
1245    }
1246
1247    #[test]
1248    fn deserialize_json_with_overrides() {
1249        let json = r#"{
1250            "overrides": [
1251                {
1252                    "files": ["*.test.ts", "*.spec.ts"],
1253                    "rules": {
1254                        "unused-exports": "off",
1255                        "unused-files": "warn"
1256                    }
1257                }
1258            ]
1259        }"#;
1260        let config: FallowConfig = serde_json::from_str(json).unwrap();
1261        assert_eq!(config.overrides.len(), 1);
1262        assert_eq!(config.overrides[0].files.len(), 2);
1263        assert_eq!(
1264            config.overrides[0].rules.unused_exports,
1265            Some(Severity::Off)
1266        );
1267        assert_eq!(config.overrides[0].rules.unused_files, Some(Severity::Warn));
1268    }
1269
1270    #[test]
1271    fn deserialize_json_with_boundaries() {
1272        let json = r#"{
1273            "boundaries": {
1274                "preset": "layered"
1275            }
1276        }"#;
1277        let config: FallowConfig = serde_json::from_str(json).unwrap();
1278        assert_eq!(config.boundaries.preset, Some(BoundaryPreset::Layered));
1279    }
1280
1281    #[test]
1282    fn deserialize_toml_with_regression_baseline() {
1283        let toml_str = r"
1284[regression.baseline]
1285totalIssues = 50
1286unusedFiles = 10
1287unusedExports = 15
1288";
1289        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1290        let baseline = config.regression.unwrap().baseline.unwrap();
1291        assert_eq!(baseline.total_issues, 50);
1292        assert_eq!(baseline.unused_files, 10);
1293        assert_eq!(baseline.unused_exports, 15);
1294    }
1295
1296    #[test]
1297    fn deserialize_toml_with_overrides() {
1298        let toml_str = r#"
1299[[overrides]]
1300files = ["*.test.ts"]
1301
1302[overrides.rules]
1303unused-exports = "off"
1304
1305[[overrides]]
1306files = ["*.stories.tsx"]
1307
1308[overrides.rules]
1309unused-files = "off"
1310"#;
1311        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1312        assert_eq!(config.overrides.len(), 2);
1313        assert_eq!(
1314            config.overrides[0].rules.unused_exports,
1315            Some(Severity::Off)
1316        );
1317        assert_eq!(config.overrides[1].rules.unused_files, Some(Severity::Off));
1318    }
1319
1320    #[test]
1321    fn regression_config_default_is_none_baseline() {
1322        let config = RegressionConfig::default();
1323        assert!(config.baseline.is_none());
1324    }
1325
1326    #[test]
1327    fn deserialize_json_multiple_ignore_export_rules() {
1328        let json = r#"{
1329            "ignoreExports": [
1330                {"file": "src/types/**/*.ts", "exports": ["*"]},
1331                {"file": "src/constants.ts", "exports": ["FOO", "BAR"]},
1332                {"file": "src/index.ts", "exports": ["default"]}
1333            ]
1334        }"#;
1335        let config: FallowConfig = serde_json::from_str(json).unwrap();
1336        assert_eq!(config.ignore_exports.len(), 3);
1337        assert_eq!(config.ignore_exports[2].exports, vec!["default"]);
1338    }
1339
1340    #[test]
1341    fn deserialize_json_public_packages_camel_case() {
1342        let json = r#"{"publicPackages": ["@myorg/shared-lib", "@myorg/utils"]}"#;
1343        let config: FallowConfig = serde_json::from_str(json).unwrap();
1344        assert_eq!(
1345            config.public_packages,
1346            vec!["@myorg/shared-lib", "@myorg/utils"]
1347        );
1348    }
1349
1350    #[test]
1351    fn deserialize_json_public_packages_rejects_snake_case() {
1352        let json = r#"{"public_packages": ["@myorg/shared-lib"]}"#;
1353        let result: Result<FallowConfig, _> = serde_json::from_str(json);
1354        assert!(
1355            result.is_err(),
1356            "snake_case should be rejected by deny_unknown_fields + rename_all camelCase"
1357        );
1358    }
1359
1360    #[test]
1361    fn deserialize_json_public_packages_empty() {
1362        let config: FallowConfig = serde_json::from_str("{}").unwrap();
1363        assert!(config.public_packages.is_empty());
1364    }
1365
1366    #[test]
1367    fn deserialize_toml_public_packages() {
1368        let toml_str = r#"
1369publicPackages = ["@myorg/shared-lib", "@myorg/ui"]
1370"#;
1371        let config: FallowConfig = toml::from_str(toml_str).unwrap();
1372        assert_eq!(
1373            config.public_packages,
1374            vec!["@myorg/shared-lib", "@myorg/ui"]
1375        );
1376    }
1377
1378    #[test]
1379    fn public_packages_serialize_roundtrip() {
1380        let config = FallowConfig {
1381            public_packages: vec!["@myorg/shared-lib".to_string()],
1382            ..FallowConfig::default()
1383        };
1384        let json = serde_json::to_string(&config).unwrap();
1385        let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1386        assert_eq!(restored.public_packages, vec!["@myorg/shared-lib"]);
1387    }
1388}