fallow_config/config/mod.rs
1mod boundaries;
2mod dependency_ignore;
3mod duplicates_config;
4mod entry_effect;
5mod entry_span;
6mod finding_ignore;
7mod flags;
8mod format;
9pub mod glob_validation;
10mod health;
11mod ignore_patterns;
12mod legacy_glob;
13mod mutation;
14mod parsing;
15mod resolution;
16mod resolve;
17mod rules;
18mod similar_code;
19mod used_class_members;
20
21#[expect(
22 clippy::redundant_pub_crate,
23 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"
24)]
25pub(crate) use boundaries::wildcard_placement_error;
26pub use boundaries::{
27 AuthoredRule, BoundaryCallsConfig, BoundaryConfig, BoundaryCoverageConfig, BoundaryPreset,
28 BoundaryRule, BoundaryZone, ForbiddenCallRule, ForbiddenCallee, InvalidForbiddenCallee,
29 LogicalGroup, LogicalGroupStatus, RedundantRootPrefix, ResolvedBoundaryConfig,
30 ResolvedBoundaryCoverageConfig, ResolvedBoundaryRule, ResolvedZone, UnknownZoneRef,
31 ZoneReferenceKind, ZoneValidationError,
32};
33pub use dependency_ignore::{IgnoreDependencyMatcher, is_dependency_glob};
34pub use duplicates_config::{
35 DetectionMode, DuplicatesConfig, NormalizationConfig, ResolvedNormalization,
36};
37pub use entry_effect::EntryEffectRecord;
38pub use entry_span::ConfigEntrySpan;
39pub use finding_ignore::FindingIgnoreMatcher;
40pub use flags::{FlagsConfig, SdkPattern};
41pub use format::OutputFormat;
42pub use glob_validation::compile_path_glob;
43pub use health::{
44 ChangeCouplingConfig, CyclomaticPolicy, EmailMode, HealthConfig, HealthThresholdOverride,
45 OwnershipConfig,
46};
47pub use ignore_patterns::{IgnorePatternSet, UNLIFTABLE_IGNORE_SEGMENTS};
48pub use legacy_glob::{
49 LegacyGlobGroup, LegacyGlobNarrowing, find_legacy_glob_narrowings, has_single_segment_wildcard,
50 suggest_cross_directory_rewrite,
51};
52pub use mutation::{MutationConfig, MutationOperatorName, MutationRunner};
53pub use parsing::{CONFIG_FILE_NAMES, ConfigLoadOptions};
54pub use resolution::{
55 AnalysisSnapshot, CACHE_DIR_ENV, CACHE_MAX_SIZE_ENV, CompiledIgnoreCatalogReferenceRule,
56 CompiledIgnoreDependencyOverrideRule, CompiledIgnoreExportRule, ConfigOverride,
57 DEFAULT_IGNORE_PATTERNS, DEFAULT_MAX_FILE_SIZE_BYTES, DEFAULT_MAX_FILE_SIZE_MB,
58 IgnoreCatalogReferenceRule, IgnoreDependencyOverrideRule, IgnoreExportRule,
59 PACKAGE_BASELINES_ENV, ResolvedConfig, ResolvedOverride, cache_config_hash,
60 cache_dir_env_override, cache_dir_from_env_value, cache_max_size_env_override,
61 cache_max_size_from_env_value, package_baselines_disabled_by_env_value,
62 resolve_max_file_size_bytes,
63};
64pub use resolve::ResolveConfig;
65pub use rules::{
66 KNOWN_RULE_NAMES, PartialRulesConfig, RulesConfig, Severity, closest_known_rule_name,
67 default_severity_for_kind, is_opt_in_kind,
68};
69pub use similar_code::SimilarCodeConfig;
70pub use used_class_members::{ScopedUsedClassMemberRule, UsedClassMemberRule};
71
72use schemars::JsonSchema;
73use serde::{Deserialize, Deserializer, Serialize};
74use std::ops::Not;
75use std::path::PathBuf;
76
77use crate::external_plugin::ExternalPluginDef;
78use crate::workspace::WorkspaceConfig;
79
80/// Value of the `ignoreExportsUsedInFile` config key: whether an export
81/// referenced elsewhere in its own file is suppressed from `unused-export`.
82#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
83#[serde(untagged, rename_all = "camelCase")]
84pub enum IgnoreExportsUsedInFileConfig {
85 /// Blanket toggle: `true` suppresses any export with a same-file use,
86 /// regardless of kind. The default is `false`.
87 Bool(bool),
88 /// Knip-parity object form restricting the suppression to type-only
89 /// exports.
90 ByKind(IgnoreExportsUsedInFileByKind),
91}
92
93impl Default for IgnoreExportsUsedInFileConfig {
94 fn default() -> Self {
95 Self::Bool(false)
96 }
97}
98
99impl From<bool> for IgnoreExportsUsedInFileConfig {
100 fn from(value: bool) -> Self {
101 Self::Bool(value)
102 }
103}
104
105impl From<IgnoreExportsUsedInFileByKind> for IgnoreExportsUsedInFileConfig {
106 fn from(value: IgnoreExportsUsedInFileByKind) -> Self {
107 Self::ByKind(value)
108 }
109}
110
111impl IgnoreExportsUsedInFileConfig {
112 /// Whether any form of the same-file-use suppression is active (the bool
113 /// form is `true`, or either by-kind field is set).
114 #[must_use]
115 pub const fn is_enabled(self) -> bool {
116 match self {
117 Self::Bool(value) => value,
118 Self::ByKind(kind) => kind.type_ || kind.interface,
119 }
120 }
121
122 /// Whether an export with a same-file use should be suppressed, given
123 /// whether fallow classified it as type-only. The bool form suppresses
124 /// regardless of kind; the by-kind form suppresses type-only exports only.
125 #[must_use]
126 pub const fn suppresses(self, is_type_only: bool) -> bool {
127 match self {
128 Self::Bool(value) => value,
129 Self::ByKind(kind) => is_type_only && (kind.type_ || kind.interface),
130 }
131 }
132}
133
134/// Object form of `ignoreExportsUsedInFile` (`{ "type": ..., "interface": ... }`),
135/// restricting the same-file-use suppression to type-only exports.
136#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
137#[serde(rename_all = "camelCase")]
138pub struct IgnoreExportsUsedInFileByKind {
139 /// 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.
140 #[serde(default, rename = "type")]
141 pub type_: bool,
142 /// 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.
143 #[serde(default)]
144 pub interface: bool,
145}
146
147/// Options for the `unused-component-props` rule.
148///
149/// Lets a project exempt component props whose local destructure binding name
150/// matches a regex from `unused-component-props`, honoring the
151/// "accepted-but-intentionally-unused" leading-underscore convention (Svelte 5
152/// `$props()`, React destructure) that mirrors TypeScript `noUnusedParameters`
153/// and ESLint `@typescript-eslint/no-unused-vars` `varsIgnorePattern` /
154/// `argsIgnorePattern`. Opt-in; an unset `ignorePattern` leaves the rule's
155/// behavior unchanged.
156#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
157#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
158pub struct UnusedComponentPropsConfig {
159 /// Regex matched against each declared prop's LOCAL destructure binding name
160 /// (e.g. `_stage` in `let { stage: _stage } = $props()`), which falls back
161 /// to the public prop name when there is no alias. A prop whose local name
162 /// matches is treated as intentionally unused and never reported as
163 /// `unused-component-props`. Matching is unanchored (substring), like
164 /// ESLint's `RegExp.test`, so anchor with `^_` to match a leading
165 /// underscore. Compiled and validated at config load (an invalid regex fails
166 /// load). Applies to Vue, Svelte, Astro, and React/Preact props.
167 #[serde(default, skip_serializing_if = "Option::is_none")]
168 pub ignore_pattern: Option<String>,
169}
170
171impl UnusedComponentPropsConfig {
172 /// True when no option is set, so serialization can omit the section.
173 #[must_use]
174 pub fn is_default(&self) -> bool {
175 self.ignore_pattern.is_none()
176 }
177}
178
179/// Options for the `circular-dependencies` rule.
180///
181/// The default leaves the rule unchanged: every runtime import edge takes
182/// part in cycle detection, and only type-only edges are skipped.
183#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
184#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
185pub struct CircularDependenciesConfig {
186 /// Skip import edges that load their target on demand or on another
187 /// thread when fallow looks for cycles. A literal `import()` inside a
188 /// function, a template `import()`, a lazy `import.meta.glob`, a worker
189 /// URL and a webpack worker loader request (`worker-loader!./work.js`)
190 /// are lazy edges. A top-level `await import()`, `require()` and an
191 /// eager `import.meta.glob` load before the module finishes, so they stay.
192 /// An edge that also carries a static import stays. Default `false`.
193 #[serde(default, skip_serializing_if = "std::ops::Not::not")]
194 pub ignore_lazy_imports: bool,
195}
196
197impl CircularDependenciesConfig {
198 /// True when no option is set, so serialization can omit the section.
199 #[must_use]
200 pub const fn is_default(&self) -> bool {
201 !self.ignore_lazy_imports
202 }
203}
204
205/// The `fix` config section: settings for `fallow fix` apply behavior.
206#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
207#[serde(rename_all = "camelCase")]
208pub struct FixConfig {
209 /// 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.
210 #[serde(default)]
211 pub catalog: CatalogFixConfig,
212}
213
214/// The `fix.catalog` section: how `fallow fix` cleans up unused
215/// `pnpm-workspace.yaml` catalog entries.
216#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
217#[serde(rename_all = "camelCase")]
218pub struct CatalogFixConfig {
219 /// 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.
220 #[serde(default)]
221 pub delete_preceding_comments: CatalogPrecedingCommentPolicy,
222}
223
224/// Value of `fix.catalog.deletePrecedingComments`: what happens to comment
225/// lines directly above a catalog entry that `fallow fix` removes. A
226/// `fallow-keep` marker in the block always preserves it regardless of policy.
227#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
228#[serde(rename_all = "lowercase")]
229pub enum CatalogPrecedingCommentPolicy {
230 /// Delete the adjacent comment block only when heuristics attribute it to
231 /// the entry (preceded by a blank line or directly under the catalog
232 /// header) and it is not a section banner. The default.
233 #[default]
234 Auto,
235 /// Always delete the adjacent comment block with the entry.
236 Always,
237 /// Never delete preceding comments.
238 Never,
239}
240
241/// Completeness policy for opt-in TypeScript semantic analysis.
242#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
243#[serde(rename_all = "kebab-case")]
244pub enum TypeAwareRequire {
245 /// Keep conservative findings and report semantic gaps without failing.
246 #[default]
247 BestEffort,
248 /// Fail the quality gate when any requested semantic query is incomplete.
249 Complete,
250}
251
252impl From<TypeAwareRequire> for fallow_types::semantic::SemanticCompletenessRequirement {
253 fn from(value: TypeAwareRequire) -> Self {
254 match value {
255 TypeAwareRequire::BestEffort => Self::BestEffort,
256 TypeAwareRequire::Complete => Self::Complete,
257 }
258 }
259}
260
261/// Shared opt-in configuration for TypeScript semantic analysis.
262#[derive(Debug, Default, Clone, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
263#[serde(deny_unknown_fields, rename_all = "camelCase")]
264pub struct TypeAwareConfig {
265 /// Enable the optional TypeScript semantic pass. Disabled by default.
266 #[serde(default)]
267 pub enabled: bool,
268 /// TypeScript project config paths, resolved relative to the project root.
269 #[serde(default, skip_serializing_if = "Vec::is_empty")]
270 pub projects: Vec<String>,
271 /// Decide whether partial semantic analysis is advisory or gating.
272 #[serde(default, skip_serializing_if = "is_default_type_aware_require")]
273 pub require: TypeAwareRequire,
274}
275
276#[expect(
277 clippy::trivially_copy_pass_by_ref,
278 reason = "serde skip_serializing_if callbacks receive field values by reference"
279)]
280fn is_default_type_aware_require(value: &TypeAwareRequire) -> bool {
281 matches!(value, TypeAwareRequire::BestEffort)
282}
283
284impl TypeAwareConfig {
285 /// True when the section equals its default (disabled, no projects,
286 /// best-effort), so serialization can omit it.
287 #[must_use]
288 pub fn is_default(&self) -> bool {
289 !self.enabled && self.projects.is_empty() && self.require == TypeAwareRequire::BestEffort
290 }
291}
292
293/// Schema for `extends`. The loader accepts one string or an array of strings
294/// and normalizes both to a list before it deserializes the config (#3351).
295fn extends_schema(_generator: &mut schemars::SchemaGenerator) -> schemars::Schema {
296 schemars::json_schema!({
297 "anyOf": [
298 { "type": "string" },
299 { "type": "array", "items": { "type": "string" } }
300 ]
301 })
302}
303
304/// The user-facing fallow configuration as authored in `.fallowrc.json` /
305/// `.fallowrc.jsonc` / `fallow.toml` / `.fallow.toml`.
306///
307/// Every field documents its serialized meaning, default, and precedence
308/// against CLI flags and environment variables where they exist.
309/// `FallowConfig::resolve` compiles the loaded config (globs, regexes,
310/// plugin and rule-pack discovery) into a [`ResolvedConfig`] for analysis.
311/// Unknown keys are rejected at load so typos fail loud.
312#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
313#[serde(deny_unknown_fields, rename_all = "camelCase")]
314// Both `.fallowrc.json` and `.fallowrc.jsonc` are read with the JSONC dialect
315// from `crate::jsonc::parse_options`, so the schema declares the same dialect.
316// JSON language service clients (VS Code, Zed) read these two keywords off the
317// root object and otherwise flag syntax the loader accepts. They are
318// annotations only: nothing in fallow reads them back.
319#[schemars(extend("allowComments" = true, "allowTrailingCommas" = true))]
320pub struct FallowConfig {
321 /// 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.
322 #[serde(rename = "$schema", default, skip_serializing)]
323 pub schema: Option<String>,
324
325 /// 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.
326 #[serde(default, skip_serializing_if = "Option::is_none")]
327 pub minimum_version: Option<String>,
328
329 /// 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).
330 #[serde(default, skip_serializing)]
331 #[schemars(schema_with = "extends_schema")]
332 pub extends: Vec<String>,
333
334 /// 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.
335 #[serde(default)]
336 pub entry: Vec<String>,
337
338 /// 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.
339 #[serde(default)]
340 pub ignore_patterns: Vec<String>,
341
342 /// 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.
343 #[serde(default, skip_serializing_if = "Vec::is_empty")]
344 pub ignore_findings: Vec<String>,
345
346 /// 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.
347 #[serde(default)]
348 pub framework: Vec<ExternalPluginDef>,
349
350 /// 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.
351 #[serde(default)]
352 pub workspaces: Option<WorkspaceConfig>,
353
354 /// 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.
355 #[serde(default)]
356 pub ignore_dependencies: Vec<String>,
357
358 /// 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.
359 #[serde(default, skip_serializing_if = "Vec::is_empty")]
360 pub ignore_command_entries: Vec<String>,
361
362 /// 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.
363 #[serde(default)]
364 pub ignore_unresolved_imports: Vec<String>,
365
366 /// 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.
367 #[serde(default)]
368 pub ignore_exports: Vec<IgnoreExportRule>,
369
370 /// 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.
371 #[serde(default, skip_serializing_if = "Vec::is_empty")]
372 pub ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>,
373
374 /// 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"`.
375 #[serde(default, skip_serializing_if = "Vec::is_empty")]
376 pub ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>,
377
378 /// 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.
379 #[serde(default)]
380 pub ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig,
381
382 /// 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.
383 #[serde(default, skip_serializing_if = "Vec::is_empty")]
384 pub ignore_decorators: Vec<String>,
385
386 /// 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.
387 #[serde(default)]
388 pub used_class_members: Vec<UsedClassMemberRule>,
389
390 /// 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.
391 #[serde(default)]
392 pub duplicates: DuplicatesConfig,
393
394 /// Configures the explicit local `similar-code` candidate workflow:
395 /// `threshold` (0.80, model-specific cosine floor), `minLines` (3), and
396 /// additional `ignore` globs. Provider identity, setup, executables,
397 /// endpoints, credentials, and consent cannot be set by project config.
398 #[serde(default)]
399 pub similar_code: SimilarCodeConfig,
400
401 /// Configures the explicit `fallow mutation` workflow: `runner` (`auto`
402 /// or `vitest`), `operators` (kebab-case names, default each operator),
403 /// `minScore` (0 to 100; a lower score exits with code 1), and
404 /// `concurrency` (half the logical cores). No key starts a run, and the
405 /// side-effect override is a CLI flag only.
406 #[serde(default, skip_serializing_if = "MutationConfig::is_default")]
407 pub mutation: MutationConfig,
408
409 /// 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.
410 #[serde(default)]
411 pub health: HealthConfig,
412
413 /// Opts into TypeScript semantic analysis for project-wide symbol use,
414 /// provenance, API surface, symbol impact, and public-signature coupling.
415 /// This does not surface compiler diagnostics or typed lint rules.
416 #[serde(default, skip_serializing_if = "TypeAwareConfig::is_default")]
417 pub type_aware: TypeAwareConfig,
418
419 /// 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.
420 #[serde(default)]
421 pub rules: RulesConfig,
422
423 #[serde(
424 default,
425 skip_serializing_if = "UnusedComponentPropsConfig::is_default"
426 )]
427 /// 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).
428 pub unused_component_props: UnusedComponentPropsConfig,
429
430 #[serde(
431 default,
432 skip_serializing_if = "CircularDependenciesConfig::is_default"
433 )]
434 /// 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.
435 pub circular_dependencies: CircularDependenciesConfig,
436
437 /// 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).
438 #[serde(default)]
439 pub boundaries: BoundaryConfig,
440
441 /// 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`).
442 #[serde(default)]
443 pub flags: FlagsConfig,
444
445 /// 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.
446 #[serde(default)]
447 pub security: SecurityConfig,
448
449 /// 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.
450 #[serde(default)]
451 pub fix: FixConfig,
452
453 /// 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.
454 #[serde(default)]
455 pub resolve: ResolveConfig,
456
457 /// 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).
458 #[serde(default)]
459 pub production: ProductionConfig,
460
461 /// 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).
462 #[serde(default)]
463 pub plugins: Vec<String>,
464
465 /// Paths to declarative rule-pack files (JSON or JSONC), relative to the
466 /// project root. Each pack declares `banned-call`, `banned-import`, or
467 /// `banned-effect` rules that report as `policy-violation` findings. Packs
468 /// are pure data: no project code is executed. Invalid or missing packs
469 /// fail config load.
470 #[serde(default, skip_serializing_if = "Vec::is_empty")]
471 pub rule_packs: Vec<String>,
472
473 /// 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.
474 #[serde(default)]
475 pub dynamically_loaded: Vec<String>,
476
477 /// 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.
478 #[serde(default)]
479 pub overrides: Vec<ConfigOverride>,
480
481 /// 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.
482 #[serde(default, skip_serializing_if = "Option::is_none")]
483 pub codeowners: Option<String>,
484
485 /// 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).
486 #[serde(default)]
487 pub public_packages: Vec<String>,
488
489 /// 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.
490 #[serde(default, skip_serializing_if = "Option::is_none")]
491 pub regression: Option<RegressionConfig>,
492
493 /// 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.
494 #[serde(default, skip_serializing_if = "AuditConfig::is_empty")]
495 pub audit: AuditConfig,
496
497 /// 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.
498 #[serde(default)]
499 pub sealed: bool,
500
501 /// 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.
502 #[serde(default)]
503 pub include_entry_exports: bool,
504
505 /// 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.
506 #[serde(default)]
507 pub show_cascade: bool,
508
509 /// 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.
510 #[serde(default)]
511 pub auto_imports: bool,
512
513 /// When true, the run fails with exit code 1 if fallow could not parse a source file cleanly (a `source-parse-degraded` or `source-nesting-too-deep` 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.
514 #[serde(default)]
515 pub fail_on_parse_error: bool,
516
517 /// 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`.
518 #[serde(default, skip_serializing_if = "CacheConfig::is_default")]
519 pub cache: CacheConfig,
520}
521
522/// Scopes `fallow security` catalogue behavior. An absent category block admits
523/// every catalogue category. `hardcoded-secret` is include-required and only
524/// runs when explicitly listed in `security.categories.include`.
525#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
526#[serde(deny_unknown_fields, rename_all = "camelCase")]
527pub struct SecurityConfig {
528 /// Include/exclude filter over category ids (e.g. `dangerous-html`).
529 #[serde(default, skip_serializing_if = "Option::is_none")]
530 pub categories: Option<SecurityCategories>,
531 /// Additional project-local names for HTTP request objects. These names
532 /// extend the built-in receiver allowlist for `*.query`, `*.params`, and
533 /// `*.body` source patterns. They do not replace the built-ins and do not
534 /// gate `*.searchParams`, which intentionally stays ungated.
535 #[serde(default, skip_serializing_if = "Vec::is_empty")]
536 pub request_receivers: Vec<String>,
537}
538
539impl SecurityConfig {
540 /// The configured `requestReceivers` trimmed, lowercased, and deduplicated
541 /// in first-seen order, with empty entries dropped; the form the matcher
542 /// compares receiver names against (matching is case-insensitive).
543 #[must_use]
544 pub fn normalized_request_receivers(&self) -> Vec<String> {
545 let mut receivers = Vec::new();
546 for receiver in &self.request_receivers {
547 let normalized = receiver.trim().to_ascii_lowercase();
548 if !normalized.is_empty() && !receivers.contains(&normalized) {
549 receivers.push(normalized);
550 }
551 }
552 receivers
553 }
554
555 /// False when any configured receiver is empty or whitespace-only, which
556 /// config validation reports as an error instead of silently dropping it.
557 #[must_use]
558 pub fn request_receivers_are_valid(&self) -> bool {
559 self.request_receivers
560 .iter()
561 .all(|receiver| !receiver.trim().is_empty())
562 }
563}
564
565/// Include/exclude lists scoping the active security categories. When `include`
566/// is set, only those categories are active; `exclude` removes categories from
567/// the admitted set. Both unset admits catalogue categories. `hardcoded-secret`
568/// still requires explicit inclusion.
569#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
570#[serde(deny_unknown_fields, rename_all = "camelCase")]
571pub struct SecurityCategories {
572 /// Catalogue category ids to admit. When set, all others are excluded.
573 #[serde(default, skip_serializing_if = "Option::is_none")]
574 pub include: Option<Vec<String>>,
575 /// Catalogue category ids to remove from the admitted set.
576 #[serde(default, skip_serializing_if = "Option::is_none")]
577 pub exclude: Option<Vec<String>>,
578}
579
580/// The `cache` config section: location and size ceiling of fallow's
581/// persistent caches (default directory `<root>/.fallow`).
582#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
583#[serde(deny_unknown_fields, rename_all = "camelCase")]
584pub struct CacheConfig {
585 /// Directory for fallow's persistent analysis cache. Relative paths resolve
586 /// from the project root.
587 #[serde(default, skip_serializing_if = "Option::is_none")]
588 pub dir: Option<PathBuf>,
589 /// Maximum size of the persistent extraction cache, in megabytes.
590 #[serde(default, skip_serializing_if = "Option::is_none")]
591 pub max_size_mb: Option<u32>,
592}
593
594impl CacheConfig {
595 /// True when neither field is set, so serialization can omit the section.
596 #[must_use]
597 pub fn is_default(&self) -> bool {
598 self.dir.is_none() && self.max_size_mb.is_none()
599 }
600}
601
602/// The analysis families production mode can be scoped to independently via
603/// the object form of the `production` config key.
604#[derive(Debug, Clone, Copy, PartialEq, Eq)]
605pub enum ProductionAnalysis {
606 /// Unused files/exports/dependencies detection.
607 DeadCode,
608 /// Complexity and health scoring.
609 Health,
610 /// Clone detection.
611 Dupes,
612}
613
614/// Value of the `production` config key: excludes test/spec/story/dev files
615/// from discovery, either globally or per analysis family.
616#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, JsonSchema)]
617#[serde(untagged)]
618pub enum ProductionConfig {
619 /// Boolean form applying to every analysis. The default is `false`.
620 Global(bool),
621 /// Object form (`{ deadCode?, health?, dupes? }`) scoping production mode
622 /// per analysis family.
623 PerAnalysis(PerAnalysisProductionConfig),
624}
625
626impl<'de> Deserialize<'de> for ProductionConfig {
627 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
628 where
629 D: Deserializer<'de>,
630 {
631 struct ProductionConfigVisitor;
632
633 impl<'de> serde::de::Visitor<'de> for ProductionConfigVisitor {
634 type Value = ProductionConfig;
635
636 fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
637 formatter.write_str("a boolean or per-analysis production config object")
638 }
639
640 fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
641 where
642 E: serde::de::Error,
643 {
644 Ok(ProductionConfig::Global(value))
645 }
646
647 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
648 where
649 A: serde::de::MapAccess<'de>,
650 {
651 PerAnalysisProductionConfig::deserialize(
652 serde::de::value::MapAccessDeserializer::new(map),
653 )
654 .map(ProductionConfig::PerAnalysis)
655 }
656 }
657
658 deserializer.deserialize_any(ProductionConfigVisitor)
659 }
660}
661
662impl Default for ProductionConfig {
663 fn default() -> Self {
664 Self::Global(false)
665 }
666}
667
668impl From<bool> for ProductionConfig {
669 fn from(value: bool) -> Self {
670 Self::Global(value)
671 }
672}
673
674impl Not for ProductionConfig {
675 type Output = bool;
676
677 fn not(self) -> Self::Output {
678 !self.any_enabled()
679 }
680}
681
682impl ProductionConfig {
683 /// Whether production mode applies to `analysis` under this config.
684 #[must_use]
685 pub const fn for_analysis(self, analysis: ProductionAnalysis) -> bool {
686 match self {
687 Self::Global(value) => value,
688 Self::PerAnalysis(config) => match analysis {
689 ProductionAnalysis::DeadCode => config.dead_code,
690 ProductionAnalysis::Health => config.health,
691 ProductionAnalysis::Dupes => config.dupes,
692 },
693 }
694 }
695
696 /// The boolean form's value; `false` for the per-analysis form, which has
697 /// no global toggle.
698 #[must_use]
699 pub const fn global(self) -> bool {
700 match self {
701 Self::Global(value) => value,
702 Self::PerAnalysis(_) => false,
703 }
704 }
705
706 /// Whether production mode is enabled for at least one analysis family.
707 #[must_use]
708 pub const fn any_enabled(self) -> bool {
709 match self {
710 Self::Global(value) => value,
711 Self::PerAnalysis(config) => config.dead_code || config.health || config.dupes,
712 }
713 }
714}
715
716/// Object form of the `production` config key, scoping production mode to
717/// individual analysis families in combined `fallow` and `fallow audit`.
718#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
719#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
720pub struct PerAnalysisProductionConfig {
721 /// 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.
722 pub dead_code: bool,
723 /// 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.
724 pub health: bool,
725 /// 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.
726 pub dupes: bool,
727}
728
729/// The `audit` config section: in-repo defaults for `fallow audit`, each
730/// overridable by its matching CLI flag.
731#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
732#[serde(rename_all = "camelCase")]
733pub struct AuditConfig {
734 /// 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.
735 #[serde(default, skip_serializing_if = "AuditGate::is_default")]
736 pub gate: AuditGate,
737
738 /// 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.
739 #[serde(default, skip_serializing_if = "AuditWorsened::is_default")]
740 pub worsened: AuditWorsened,
741
742 /// 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.
743 #[serde(default, skip_serializing_if = "Option::is_none")]
744 pub dead_code: Option<bool>,
745
746 /// 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.
747 #[serde(default, skip_serializing_if = "Option::is_none")]
748 pub health: Option<bool>,
749
750 /// 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.
751 #[serde(default, skip_serializing_if = "Option::is_none")]
752 pub dupes: Option<bool>,
753
754 /// 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.
755 #[serde(default, skip_serializing_if = "Option::is_none")]
756 pub css: Option<bool>,
757
758 /// 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.
759 #[serde(default, skip_serializing_if = "Option::is_none")]
760 pub css_deep: Option<bool>,
761
762 /// 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`.
763 #[serde(default, skip_serializing_if = "Option::is_none")]
764 pub dead_code_baseline: Option<String>,
765
766 /// 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.
767 #[serde(default, skip_serializing_if = "Option::is_none")]
768 pub health_baseline: Option<String>,
769
770 /// 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.
771 #[serde(default, skip_serializing_if = "Option::is_none")]
772 pub dupes_baseline: Option<String>,
773
774 /// 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.
775 #[serde(default, skip_serializing_if = "Option::is_none")]
776 pub cache_max_age_days: Option<u32>,
777
778 /// 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.
779 #[serde(default, skip_serializing_if = "Option::is_none")]
780 pub type_aware: Option<bool>,
781}
782
783impl AuditConfig {
784 /// True when every field is unset, so serialization can omit the section.
785 #[must_use]
786 pub fn is_empty(&self) -> bool {
787 self.gate.is_default()
788 && self.worsened.is_default()
789 && self.dead_code.is_none()
790 && self.health.is_none()
791 && self.dupes.is_none()
792 && self.css.is_none()
793 && self.css_deep.is_none()
794 && self.dead_code_baseline.is_none()
795 && self.health_baseline.is_none()
796 && self.dupes_baseline.is_none()
797 && self.cache_max_age_days.is_none()
798 && self.type_aware.is_none()
799 }
800}
801
802/// Value of `audit.gate`: which findings drive the `fallow audit` verdict.
803#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
804#[serde(rename_all = "kebab-case")]
805pub enum AuditGate {
806 /// Fail only on findings the current changeset introduced, determined by
807 /// a base-snapshot attribution pass. The default.
808 #[default]
809 NewOnly,
810 /// Fail on every finding in changed files, skipping the attribution pass.
811 All,
812}
813
814impl AuditGate {
815 /// True for the default `new-only` gate, so serialization can omit it.
816 #[must_use]
817 pub const fn is_default(&self) -> bool {
818 matches!(self, Self::NewOnly)
819 }
820}
821
822/// Value of `audit.worsened`: how a worsened complexity finding affects the
823/// `fallow audit` verdict.
824#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
825#[serde(rename_all = "kebab-case")]
826pub enum AuditWorsened {
827 /// A worsened finding makes the verdict at least `warn` and does not fail
828 /// the run. The default.
829 #[default]
830 Warn,
831 /// A worsened finding counts like an introduced finding.
832 Error,
833 /// Growth only in metrics that the finding does not exceed stays
834 /// inherited. Growth of an exceeded metric stays worsened and gives at
835 /// least `warn`.
836 Off,
837}
838
839impl AuditWorsened {
840 /// True for the default `warn` mode, so serialization can omit it.
841 #[must_use]
842 pub const fn is_default(&self) -> bool {
843 matches!(self, Self::Warn)
844 }
845}
846
847/// The `regression` config section holding the saved issue-count baseline for
848/// the `--fail-on-regression` gate.
849#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
850#[serde(rename_all = "camelCase")]
851pub struct RegressionConfig {
852 /// 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.
853 #[serde(default, skip_serializing_if = "Option::is_none")]
854 pub baseline: Option<RegressionBaseline>,
855}
856
857/// Saved per-issue-type counts written by `--save-baseline` and compared by
858/// `--fail-on-regression`. Every count defaults to `0` when its key is missing,
859/// so hand-trimmed baselines stay loadable.
860#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
861#[serde(rename_all = "camelCase")]
862pub struct RegressionBaseline {
863 /// Baseline count of optional component prop review candidates.
864 #[serde(default)]
865 pub absent_component_props: usize,
866
867 /// Compatibility identity for the analysis that produced these counts.
868 /// Missing values in existing configs are treated as syntactic.
869 #[serde(default)]
870 pub analysis_identity: fallow_types::semantic::SemanticAnalysisIdentity,
871 /// Baseline count across all issue types.
872 #[serde(default)]
873 pub total_issues: usize,
874 /// Baseline count of `unused-files` findings.
875 #[serde(default)]
876 pub unused_files: usize,
877 /// Baseline count of `unused-exports` findings.
878 #[serde(default)]
879 pub unused_exports: usize,
880 /// Baseline count of `unused-types` findings.
881 #[serde(default)]
882 pub unused_types: usize,
883 /// Baseline count of `unused-dependencies` findings.
884 #[serde(default)]
885 pub unused_dependencies: usize,
886 /// Baseline count of `unused-dev-dependencies` findings.
887 #[serde(default)]
888 pub unused_dev_dependencies: usize,
889 /// Baseline count of `unused-optional-dependencies` findings.
890 #[serde(default)]
891 pub unused_optional_dependencies: usize,
892 /// Baseline count of `unused-enum-members` findings.
893 #[serde(default)]
894 pub unused_enum_members: usize,
895 /// Baseline count of `unused-class-members` findings.
896 #[serde(default)]
897 pub unused_class_members: usize,
898 /// Baseline count of `unresolved-imports` findings.
899 #[serde(default)]
900 pub unresolved_imports: usize,
901 /// Baseline count of `unlisted-dependencies` findings.
902 #[serde(default)]
903 pub unlisted_dependencies: usize,
904 /// Baseline count of `duplicate-exports` findings.
905 #[serde(default)]
906 pub duplicate_exports: usize,
907 /// Baseline count of `circular-dependencies` findings.
908 #[serde(default)]
909 pub circular_dependencies: usize,
910 /// Baseline count of `re-export-cycle` findings.
911 #[serde(default)]
912 pub re_export_cycles: usize,
913 /// Baseline count of `package-cycle` findings.
914 #[serde(default)]
915 pub package_cycles: usize,
916 /// Baseline count of `type-only-dependencies` findings.
917 #[serde(default)]
918 pub type_only_dependencies: usize,
919 /// Baseline count of `test-only-dependencies` findings.
920 #[serde(default)]
921 pub test_only_dependencies: usize,
922 /// Baseline count of `dev-dependencies-in-production` findings.
923 #[serde(default)]
924 pub dev_dependencies_in_production: usize,
925 /// Baseline count of `boundary-violation` findings.
926 #[serde(default)]
927 pub boundary_violations: usize,
928 /// Baseline count of boundary-coverage-violation findings.
929 #[serde(default)]
930 pub boundary_coverage_violations: usize,
931 /// Baseline count of boundary-call-violation findings.
932 #[serde(default)]
933 pub boundary_call_violations: usize,
934 /// Baseline count of `policy-violation` findings.
935 #[serde(default)]
936 pub policy_violations: usize,
937}
938
939#[cfg(test)]
940mod tests {
941 use super::*;
942
943 #[test]
944 fn regression_baseline_preserves_absent_component_prop_count() {
945 let baseline: RegressionBaseline =
946 serde_json::from_value(serde_json::json!({"absentComponentProps":7})).unwrap();
947 assert_eq!(
948 serde_json::to_value(baseline).unwrap()["absentComponentProps"],
949 7
950 );
951 }
952
953 #[test]
954 fn default_config_has_empty_collections() {
955 let config = FallowConfig::default();
956 assert!(config.schema.is_none());
957 assert!(config.extends.is_empty());
958 assert!(config.entry.is_empty());
959 assert!(config.ignore_patterns.is_empty());
960 assert!(config.ignore_findings.is_empty());
961 assert!(config.framework.is_empty());
962 assert!(config.workspaces.is_none());
963 assert!(config.ignore_dependencies.is_empty());
964 assert!(config.ignore_exports.is_empty());
965 assert!(config.used_class_members.is_empty());
966 assert!(config.plugins.is_empty());
967 assert!(config.dynamically_loaded.is_empty());
968 assert!(config.overrides.is_empty());
969 assert!(config.public_packages.is_empty());
970 assert_eq!(
971 config.fix.catalog.delete_preceding_comments,
972 CatalogPrecedingCommentPolicy::Auto
973 );
974 assert!(!config.production);
975 }
976
977 #[test]
978 fn deserialize_empty_json_object() {
979 let config: FallowConfig = serde_json::from_str("{}").unwrap();
980 assert!(config.entry.is_empty());
981 assert!(!config.production);
982 assert!(!config.type_aware.enabled);
983 assert_eq!(config.type_aware.require, TypeAwareRequire::BestEffort);
984 }
985
986 #[test]
987 fn deserialize_type_aware_config() {
988 let config: FallowConfig = serde_json::from_str(
989 r#"{"typeAware":{"enabled":true,"projects":["tsconfig.app.json"],"require":"complete"}}"#,
990 )
991 .unwrap();
992
993 assert!(config.type_aware.enabled);
994 assert_eq!(config.type_aware.projects, ["tsconfig.app.json"]);
995 assert_eq!(config.type_aware.require, TypeAwareRequire::Complete);
996 }
997
998 #[test]
999 fn deserialize_type_aware_config_rejects_unknown_fields() {
1000 let result = serde_json::from_str::<FallowConfig>(
1001 r#"{"typeAware":{"enabled":true,"compilerDiagnostics":true}}"#,
1002 );
1003 assert!(result.is_err());
1004 }
1005
1006 #[test]
1007 fn deserialize_json_with_all_top_level_fields() {
1008 let json = r#"{
1009 "$schema": "./node_modules/fallow/schema.json",
1010 "entry": ["src/main.ts"],
1011 "ignorePatterns": ["generated/**"],
1012 "ignoreFindings": ["**/*.test.ts", "!src/public/**"],
1013 "ignoreDependencies": ["postcss"],
1014 "production": true,
1015 "plugins": ["custom-plugin.toml"],
1016 "rules": {"unused-files": "warn"},
1017 "duplicates": {"enabled": false},
1018 "health": {"maxCyclomatic": 30}
1019 }"#;
1020 let config: FallowConfig = serde_json::from_str(json).unwrap();
1021 assert_eq!(
1022 config.schema.as_deref(),
1023 Some("./node_modules/fallow/schema.json")
1024 );
1025 assert_eq!(config.entry, vec!["src/main.ts"]);
1026 assert_eq!(config.ignore_patterns, vec!["generated/**"]);
1027 assert_eq!(
1028 config.ignore_findings,
1029 vec!["**/*.test.ts", "!src/public/**"]
1030 );
1031 assert_eq!(config.ignore_dependencies, vec!["postcss"]);
1032 assert!(config.production);
1033 assert_eq!(config.plugins, vec!["custom-plugin.toml"]);
1034 assert_eq!(config.rules.unused_files, Severity::Warn);
1035 assert!(!config.duplicates.enabled);
1036 assert_eq!(config.health.max_cyclomatic, 30);
1037 }
1038
1039 #[test]
1040 fn deserialize_json_deny_unknown_fields() {
1041 let json = r#"{"unknownField": true}"#;
1042 let result: Result<FallowConfig, _> = serde_json::from_str(json);
1043 assert!(result.is_err(), "unknown fields should be rejected");
1044 }
1045
1046 #[test]
1047 fn ignore_findings_serialization_is_canonical_and_sparse() {
1048 let default_value = serde_json::to_value(FallowConfig::default()).unwrap();
1049 assert!(default_value.get("ignoreFindings").is_none());
1050
1051 let config = FallowConfig {
1052 ignore_findings: vec!["**/*.test.ts".to_string(), "!src/public/**".to_string()],
1053 ..Default::default()
1054 };
1055 let value = serde_json::to_value(config).unwrap();
1056 assert_eq!(
1057 value.get("ignoreFindings"),
1058 Some(&serde_json::json!(["**/*.test.ts", "!src/public/**"]))
1059 );
1060 }
1061
1062 #[test]
1063 fn ignore_findings_deserializes_from_toml() {
1064 let config: FallowConfig =
1065 toml::from_str(r#"ignoreFindings = ["**/*.test.ts", "!src/public/**"]"#).unwrap();
1066
1067 assert_eq!(
1068 config.ignore_findings,
1069 vec!["**/*.test.ts", "!src/public/**"]
1070 );
1071 }
1072
1073 #[test]
1074 fn generic_ignore_alias_is_rejected() {
1075 let result = serde_json::from_str::<FallowConfig>(r#"{"ignore": ["**/*.test.ts"]}"#);
1076
1077 assert!(result.is_err());
1078 }
1079
1080 #[test]
1081 fn deserialize_json_production_mode_default_false() {
1082 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1083 assert!(!config.production);
1084 }
1085
1086 #[test]
1087 fn deserialize_json_production_mode_true() {
1088 let config: FallowConfig = serde_json::from_str(r#"{"production": true}"#).unwrap();
1089 assert!(config.production);
1090 }
1091
1092 #[test]
1093 fn deserialize_json_per_analysis_production_mode() {
1094 let config: FallowConfig = serde_json::from_str(
1095 r#"{"production": {"deadCode": false, "health": true, "dupes": false}}"#,
1096 )
1097 .unwrap();
1098 assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
1099 assert!(config.production.for_analysis(ProductionAnalysis::Health));
1100 assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
1101 }
1102
1103 #[test]
1104 fn deserialize_json_per_analysis_production_mode_rejects_unknown_fields() {
1105 let err = serde_json::from_str::<FallowConfig>(r#"{"production": {"healthTypo": true}}"#)
1106 .unwrap_err();
1107 assert!(
1108 err.to_string().contains("healthTypo"),
1109 "error should name the unknown field: {err}"
1110 );
1111 }
1112
1113 #[test]
1114 fn deserialize_json_dynamically_loaded() {
1115 let json = r#"{"dynamicallyLoaded": ["plugins/**/*.ts", "locales/**/*.json"]}"#;
1116 let config: FallowConfig = serde_json::from_str(json).unwrap();
1117 assert_eq!(
1118 config.dynamically_loaded,
1119 vec!["plugins/**/*.ts", "locales/**/*.json"]
1120 );
1121 }
1122
1123 #[test]
1124 fn deserialize_json_dynamically_loaded_defaults_empty() {
1125 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1126 assert!(config.dynamically_loaded.is_empty());
1127 }
1128
1129 #[test]
1130 fn deserialize_json_fix_catalog_delete_preceding_comments() {
1131 let config: FallowConfig =
1132 serde_json::from_str(r#"{"fix": {"catalog": {"deletePrecedingComments": "always"}}}"#)
1133 .unwrap();
1134 assert_eq!(
1135 config.fix.catalog.delete_preceding_comments,
1136 CatalogPrecedingCommentPolicy::Always
1137 );
1138 }
1139
1140 #[test]
1141 fn deserialize_json_fix_catalog_delete_preceding_comments_rejects_unknown_policy() {
1142 let err = serde_json::from_str::<FallowConfig>(
1143 r#"{"fix": {"catalog": {"deletePrecedingComments": "sometimes"}}}"#,
1144 )
1145 .unwrap_err();
1146 assert!(
1147 err.to_string().contains("sometimes"),
1148 "error should name the bad policy: {err}"
1149 );
1150 }
1151
1152 #[test]
1153 fn deserialize_json_used_class_members_supports_strings_and_scoped_rules() {
1154 let json = r#"{
1155 "usedClassMembers": [
1156 "agInit",
1157 { "implements": "ICellRendererAngularComp", "members": ["refresh"] },
1158 { "extends": "BaseCommand", "implements": "CanActivate", "members": ["execute"] }
1159 ]
1160 }"#;
1161 let config: FallowConfig = serde_json::from_str(json).unwrap();
1162 assert_eq!(
1163 config.used_class_members,
1164 vec![
1165 UsedClassMemberRule::from("agInit"),
1166 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1167 extends: None,
1168 implements: Some("ICellRendererAngularComp".to_string()),
1169 members: vec!["refresh".to_string()],
1170 }),
1171 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1172 extends: Some("BaseCommand".to_string()),
1173 implements: Some("CanActivate".to_string()),
1174 members: vec!["execute".to_string()],
1175 }),
1176 ]
1177 );
1178 }
1179
1180 #[test]
1181 fn deserialize_toml_minimal() {
1182 let toml_str = r#"
1183entry = ["src/index.ts"]
1184production = true
1185"#;
1186 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1187 assert_eq!(config.entry, vec!["src/index.ts"]);
1188 assert!(config.production);
1189 }
1190
1191 #[test]
1192 fn workspaces_packages_key_is_accepted_as_patterns_alias() {
1193 // An older `fallow init --toml` wrote `[workspaces]` with a `packages`
1194 // key; the back-compat serde alias keeps those existing configs scoping
1195 // instead of silently dropping the (unknown) key and losing the patterns.
1196 let config: FallowConfig =
1197 toml::from_str("[workspaces]\npackages = [\"packages/*\", \"apps/*\"]").unwrap();
1198 assert_eq!(
1199 config.workspaces.map(|w| w.patterns).unwrap_or_default(),
1200 vec!["packages/*".to_string(), "apps/*".to_string()],
1201 "the `packages` alias must populate `patterns`"
1202 );
1203 }
1204
1205 #[test]
1206 fn deserialize_toml_per_analysis_production_mode() {
1207 let toml_str = r"
1208[production]
1209deadCode = false
1210health = true
1211dupes = false
1212";
1213 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1214 assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
1215 assert!(config.production.for_analysis(ProductionAnalysis::Health));
1216 assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
1217 }
1218
1219 #[test]
1220 fn deserialize_toml_per_analysis_production_mode_rejects_unknown_fields() {
1221 let err = toml::from_str::<FallowConfig>(
1222 r"
1223[production]
1224healthTypo = true
1225",
1226 )
1227 .unwrap_err();
1228 assert!(
1229 err.to_string().contains("healthTypo"),
1230 "error should name the unknown field: {err}"
1231 );
1232 }
1233
1234 #[test]
1235 fn deserialize_toml_with_inline_framework() {
1236 let toml_str = r#"
1237[[framework]]
1238name = "my-framework"
1239enablers = ["my-framework-pkg"]
1240entryPoints = ["src/routes/**/*.tsx"]
1241"#;
1242 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1243 assert_eq!(config.framework.len(), 1);
1244 assert_eq!(config.framework[0].name, "my-framework");
1245 assert_eq!(config.framework[0].enablers, vec!["my-framework-pkg"]);
1246 assert_eq!(
1247 config.framework[0].entry_points,
1248 vec!["src/routes/**/*.tsx"]
1249 );
1250 }
1251
1252 #[test]
1253 fn deserialize_toml_fix_catalog_delete_preceding_comments() {
1254 let toml_str = r#"
1255[fix.catalog]
1256deletePrecedingComments = "never"
1257"#;
1258 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1259 assert_eq!(
1260 config.fix.catalog.delete_preceding_comments,
1261 CatalogPrecedingCommentPolicy::Never
1262 );
1263 }
1264
1265 #[test]
1266 fn deserialize_toml_with_workspace_config() {
1267 let toml_str = r#"
1268[workspaces]
1269patterns = ["packages/*", "apps/*"]
1270[workspaces.changedSince]
1271"packages/web" = "main"
1272"packages/legacy" = "release/2024.10"
1273"#;
1274 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1275 assert!(config.workspaces.is_some());
1276 let ws = config.workspaces.unwrap();
1277 assert_eq!(ws.patterns, vec!["packages/*", "apps/*"]);
1278 assert_eq!(ws.changed_since["packages/web"], "main");
1279 assert_eq!(ws.changed_since["packages/legacy"], "release/2024.10");
1280 }
1281
1282 #[test]
1283 fn deserialize_toml_with_ignore_exports() {
1284 let toml_str = r#"
1285[[ignoreExports]]
1286file = "src/types/**/*.ts"
1287exports = ["*"]
1288"#;
1289 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1290 assert_eq!(config.ignore_exports.len(), 1);
1291 assert_eq!(config.ignore_exports[0].file, "src/types/**/*.ts");
1292 assert_eq!(config.ignore_exports[0].exports, vec!["*"]);
1293 }
1294
1295 #[test]
1296 fn deserialize_toml_used_class_members_supports_scoped_rules() {
1297 let toml_str = r#"
1298usedClassMembers = [
1299 { implements = "ICellRendererAngularComp", members = ["refresh"] },
1300 { extends = "BaseCommand", members = ["execute"] },
1301]
1302"#;
1303 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1304 assert_eq!(
1305 config.used_class_members,
1306 vec![
1307 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1308 extends: None,
1309 implements: Some("ICellRendererAngularComp".to_string()),
1310 members: vec!["refresh".to_string()],
1311 }),
1312 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1313 extends: Some("BaseCommand".to_string()),
1314 implements: None,
1315 members: vec!["execute".to_string()],
1316 }),
1317 ]
1318 );
1319 }
1320
1321 #[test]
1322 fn deserialize_json_used_class_members_rejects_unconstrained_scoped_rules() {
1323 let result = serde_json::from_str::<FallowConfig>(
1324 r#"{"usedClassMembers":[{"members":["refresh"]}]}"#,
1325 );
1326 assert!(
1327 result.is_err(),
1328 "unconstrained scoped rule should be rejected"
1329 );
1330 }
1331
1332 #[test]
1333 fn deserialize_ignore_exports_used_in_file_bool() {
1334 let config: FallowConfig =
1335 serde_json::from_str(r#"{"ignoreExportsUsedInFile":true}"#).unwrap();
1336
1337 assert!(config.ignore_exports_used_in_file.suppresses(false));
1338 assert!(config.ignore_exports_used_in_file.suppresses(true));
1339 }
1340
1341 #[test]
1342 fn deserialize_ignore_exports_used_in_file_kind_form() {
1343 let config: FallowConfig =
1344 serde_json::from_str(r#"{"ignoreExportsUsedInFile":{"type":true}}"#).unwrap();
1345
1346 assert!(!config.ignore_exports_used_in_file.suppresses(false));
1347 assert!(config.ignore_exports_used_in_file.suppresses(true));
1348 }
1349
1350 #[test]
1351 fn deserialize_toml_deny_unknown_fields() {
1352 let toml_str = r"bogus_field = true";
1353 let result: Result<FallowConfig, _> = toml::from_str(toml_str);
1354 assert!(result.is_err(), "unknown fields should be rejected");
1355 }
1356
1357 #[test]
1358 fn json_serialize_roundtrip() {
1359 let config = FallowConfig {
1360 entry: vec!["src/main.ts".to_string()],
1361 production: true.into(),
1362 ..FallowConfig::default()
1363 };
1364 let json = serde_json::to_string(&config).unwrap();
1365 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1366 assert_eq!(restored.entry, vec!["src/main.ts"]);
1367 assert!(restored.production);
1368 }
1369
1370 #[test]
1371 fn schema_field_not_serialized() {
1372 let config = FallowConfig {
1373 schema: Some("https://example.com/schema.json".to_string()),
1374 ..FallowConfig::default()
1375 };
1376 let json = serde_json::to_string(&config).unwrap();
1377 assert!(
1378 !json.contains("$schema"),
1379 "schema field should be skipped in serialization"
1380 );
1381 }
1382
1383 #[test]
1384 fn extends_field_not_serialized() {
1385 let config = FallowConfig {
1386 extends: vec!["base.json".to_string()],
1387 ..FallowConfig::default()
1388 };
1389 let json = serde_json::to_string(&config).unwrap();
1390 assert!(
1391 !json.contains("extends"),
1392 "extends field should be skipped in serialization"
1393 );
1394 }
1395
1396 #[test]
1397 fn regression_config_deserialize_json() {
1398 let json = r#"{
1399 "regression": {
1400 "baseline": {
1401 "totalIssues": 42,
1402 "unusedFiles": 10,
1403 "unusedExports": 5,
1404 "circularDependencies": 2
1405 }
1406 }
1407 }"#;
1408 let config: FallowConfig = serde_json::from_str(json).unwrap();
1409 let regression = config.regression.unwrap();
1410 let baseline = regression.baseline.unwrap();
1411 assert_eq!(baseline.total_issues, 42);
1412 assert_eq!(baseline.unused_files, 10);
1413 assert_eq!(baseline.unused_exports, 5);
1414 assert_eq!(baseline.circular_dependencies, 2);
1415 assert_eq!(baseline.unused_types, 0);
1416 assert_eq!(baseline.boundary_violations, 0);
1417 }
1418
1419 #[test]
1420 fn regression_config_defaults_to_none() {
1421 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1422 assert!(config.regression.is_none());
1423 }
1424
1425 #[test]
1426 fn regression_baseline_all_zeros_by_default() {
1427 let baseline = RegressionBaseline::default();
1428 assert_eq!(baseline.total_issues, 0);
1429 assert_eq!(baseline.unused_files, 0);
1430 assert_eq!(baseline.unused_exports, 0);
1431 assert_eq!(baseline.unused_types, 0);
1432 assert_eq!(baseline.unused_dependencies, 0);
1433 assert_eq!(baseline.unused_dev_dependencies, 0);
1434 assert_eq!(baseline.unused_optional_dependencies, 0);
1435 assert_eq!(baseline.unused_enum_members, 0);
1436 assert_eq!(baseline.unused_class_members, 0);
1437 assert_eq!(baseline.unresolved_imports, 0);
1438 assert_eq!(baseline.unlisted_dependencies, 0);
1439 assert_eq!(baseline.duplicate_exports, 0);
1440 assert_eq!(baseline.circular_dependencies, 0);
1441 assert_eq!(baseline.type_only_dependencies, 0);
1442 assert_eq!(baseline.test_only_dependencies, 0);
1443 assert_eq!(baseline.boundary_violations, 0);
1444 }
1445
1446 #[test]
1447 fn regression_config_serialize_roundtrip() {
1448 let baseline = RegressionBaseline {
1449 total_issues: 100,
1450 unused_files: 20,
1451 unused_exports: 30,
1452 ..RegressionBaseline::default()
1453 };
1454 let regression = RegressionConfig {
1455 baseline: Some(baseline),
1456 };
1457 let config = FallowConfig {
1458 regression: Some(regression),
1459 ..FallowConfig::default()
1460 };
1461 let json = serde_json::to_string(&config).unwrap();
1462 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1463 let restored_baseline = restored.regression.unwrap().baseline.unwrap();
1464 assert_eq!(restored_baseline.total_issues, 100);
1465 assert_eq!(restored_baseline.unused_files, 20);
1466 assert_eq!(restored_baseline.unused_exports, 30);
1467 assert_eq!(restored_baseline.unused_types, 0);
1468 }
1469
1470 #[test]
1471 fn regression_config_empty_baseline_deserialize() {
1472 let json = r#"{"regression": {}}"#;
1473 let config: FallowConfig = serde_json::from_str(json).unwrap();
1474 let regression = config.regression.unwrap();
1475 assert!(regression.baseline.is_none());
1476 }
1477
1478 #[test]
1479 fn regression_baseline_not_serialized_when_none() {
1480 let config = FallowConfig {
1481 regression: None,
1482 ..FallowConfig::default()
1483 };
1484 let json = serde_json::to_string(&config).unwrap();
1485 assert!(
1486 !json.contains("regression"),
1487 "regression should be skipped when None"
1488 );
1489 }
1490
1491 #[test]
1492 fn deserialize_json_with_overrides() {
1493 let json = r#"{
1494 "overrides": [
1495 {
1496 "files": ["*.test.ts", "*.spec.ts"],
1497 "rules": {
1498 "unused-exports": "off",
1499 "unused-files": "warn"
1500 }
1501 }
1502 ]
1503 }"#;
1504 let config: FallowConfig = serde_json::from_str(json).unwrap();
1505 assert_eq!(config.overrides.len(), 1);
1506 assert_eq!(config.overrides[0].files.len(), 2);
1507 assert_eq!(
1508 config.overrides[0].rules.unused_exports,
1509 Some(Severity::Off)
1510 );
1511 assert_eq!(config.overrides[0].rules.unused_files, Some(Severity::Warn));
1512 }
1513
1514 #[test]
1515 fn deserialize_json_with_boundaries() {
1516 let json = r#"{
1517 "boundaries": {
1518 "preset": "layered"
1519 }
1520 }"#;
1521 let config: FallowConfig = serde_json::from_str(json).unwrap();
1522 assert_eq!(config.boundaries.preset, Some(BoundaryPreset::Layered));
1523 }
1524
1525 #[test]
1526 fn deserialize_toml_with_regression_baseline() {
1527 let toml_str = r"
1528[regression.baseline]
1529totalIssues = 50
1530unusedFiles = 10
1531unusedExports = 15
1532";
1533 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1534 let baseline = config.regression.unwrap().baseline.unwrap();
1535 assert_eq!(baseline.total_issues, 50);
1536 assert_eq!(baseline.unused_files, 10);
1537 assert_eq!(baseline.unused_exports, 15);
1538 }
1539
1540 #[test]
1541 fn deserialize_toml_with_overrides() {
1542 let toml_str = r#"
1543[[overrides]]
1544files = ["*.test.ts"]
1545
1546[overrides.rules]
1547unused-exports = "off"
1548
1549[[overrides]]
1550files = ["*.stories.tsx"]
1551
1552[overrides.rules]
1553unused-files = "off"
1554"#;
1555 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1556 assert_eq!(config.overrides.len(), 2);
1557 assert_eq!(
1558 config.overrides[0].rules.unused_exports,
1559 Some(Severity::Off)
1560 );
1561 assert_eq!(config.overrides[1].rules.unused_files, Some(Severity::Off));
1562 }
1563
1564 #[test]
1565 fn regression_config_default_is_none_baseline() {
1566 let config = RegressionConfig::default();
1567 assert!(config.baseline.is_none());
1568 }
1569
1570 #[test]
1571 fn deserialize_json_multiple_ignore_export_rules() {
1572 let json = r#"{
1573 "ignoreExports": [
1574 {"file": "src/types/**/*.ts", "exports": ["*"]},
1575 {"file": "src/constants.ts", "exports": ["FOO", "BAR"]},
1576 {"file": "src/index.ts", "exports": ["default"]}
1577 ]
1578 }"#;
1579 let config: FallowConfig = serde_json::from_str(json).unwrap();
1580 assert_eq!(config.ignore_exports.len(), 3);
1581 assert_eq!(config.ignore_exports[2].exports, vec!["default"]);
1582 }
1583
1584 #[test]
1585 fn deserialize_json_public_packages_camel_case() {
1586 let json = r#"{"publicPackages": ["@myorg/shared-lib", "@myorg/utils"]}"#;
1587 let config: FallowConfig = serde_json::from_str(json).unwrap();
1588 assert_eq!(
1589 config.public_packages,
1590 vec!["@myorg/shared-lib", "@myorg/utils"]
1591 );
1592 }
1593
1594 #[test]
1595 fn deserialize_json_public_packages_rejects_snake_case() {
1596 let json = r#"{"public_packages": ["@myorg/shared-lib"]}"#;
1597 let result: Result<FallowConfig, _> = serde_json::from_str(json);
1598 assert!(
1599 result.is_err(),
1600 "snake_case should be rejected by deny_unknown_fields + rename_all camelCase"
1601 );
1602 }
1603
1604 #[test]
1605 fn deserialize_json_public_packages_empty() {
1606 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1607 assert!(config.public_packages.is_empty());
1608 }
1609
1610 #[test]
1611 fn deserialize_toml_public_packages() {
1612 let toml_str = r#"
1613publicPackages = ["@myorg/shared-lib", "@myorg/ui"]
1614"#;
1615 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1616 assert_eq!(
1617 config.public_packages,
1618 vec!["@myorg/shared-lib", "@myorg/ui"]
1619 );
1620 }
1621
1622 #[test]
1623 fn public_packages_serialize_roundtrip() {
1624 let config = FallowConfig {
1625 public_packages: vec!["@myorg/shared-lib".to_string()],
1626 ..FallowConfig::default()
1627 };
1628 let json = serde_json::to_string(&config).unwrap();
1629 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1630 assert_eq!(restored.public_packages, vec!["@myorg/shared-lib"]);
1631 }
1632}