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