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::ConfigLoadOptions;
35pub use resolution::{
36 AnalysisSnapshot, CompiledIgnoreCatalogReferenceRule, CompiledIgnoreDependencyOverrideRule,
37 CompiledIgnoreExportRule, ConfigOverride, 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")]
255pub struct FallowConfig {
256 /// 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.
257 #[serde(rename = "$schema", default, skip_serializing)]
258 pub schema: Option<String>,
259
260 /// 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.
261 #[serde(default, skip_serializing_if = "Option::is_none")]
262 pub minimum_version: Option<String>,
263
264 /// 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).
265 #[serde(default, skip_serializing)]
266 pub extends: Vec<String>,
267
268 /// 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.
269 #[serde(default)]
270 pub entry: Vec<String>,
271
272 /// 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.
273 #[serde(default)]
274 pub ignore_patterns: Vec<String>,
275
276 /// 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.
277 #[serde(default, skip_serializing_if = "Vec::is_empty")]
278 pub ignore_findings: Vec<String>,
279
280 /// 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.
281 #[serde(default)]
282 pub framework: Vec<ExternalPluginDef>,
283
284 /// 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.
285 #[serde(default)]
286 pub workspaces: Option<WorkspaceConfig>,
287
288 /// 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.
289 #[serde(default)]
290 pub ignore_dependencies: Vec<String>,
291
292 /// 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.
293 #[serde(default)]
294 pub ignore_unresolved_imports: Vec<String>,
295
296 /// 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.
297 #[serde(default)]
298 pub ignore_exports: Vec<IgnoreExportRule>,
299
300 /// 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.
301 #[serde(default, skip_serializing_if = "Vec::is_empty")]
302 pub ignore_catalog_references: Vec<IgnoreCatalogReferenceRule>,
303
304 /// 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"`.
305 #[serde(default, skip_serializing_if = "Vec::is_empty")]
306 pub ignore_dependency_overrides: Vec<IgnoreDependencyOverrideRule>,
307
308 /// 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.
309 #[serde(default)]
310 pub ignore_exports_used_in_file: IgnoreExportsUsedInFileConfig,
311
312 /// 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.
313 #[serde(default, skip_serializing_if = "Vec::is_empty")]
314 pub ignore_decorators: Vec<String>,
315
316 /// 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.
317 #[serde(default)]
318 pub used_class_members: Vec<UsedClassMemberRule>,
319
320 /// 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.
321 #[serde(default)]
322 pub duplicates: DuplicatesConfig,
323
324 /// Configures the explicit local `similar-code` candidate workflow:
325 /// `threshold` (0.80, model-specific cosine floor), `minLines` (3), and
326 /// additional `ignore` globs. Provider identity, setup, executables,
327 /// endpoints, credentials, and consent cannot be set by project config.
328 #[serde(default)]
329 pub similar_code: SimilarCodeConfig,
330
331 /// 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.
332 #[serde(default)]
333 pub health: HealthConfig,
334
335 /// Opts into TypeScript semantic analysis for project-wide symbol use,
336 /// provenance, API surface, symbol impact, and public-signature coupling.
337 /// This does not surface compiler diagnostics or typed lint rules.
338 #[serde(default, skip_serializing_if = "TypeAwareConfig::is_default")]
339 pub type_aware: TypeAwareConfig,
340
341 /// 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.
342 #[serde(default)]
343 pub rules: RulesConfig,
344
345 #[serde(
346 default,
347 skip_serializing_if = "UnusedComponentPropsConfig::is_default"
348 )]
349 /// 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).
350 pub unused_component_props: UnusedComponentPropsConfig,
351
352 /// 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).
353 #[serde(default)]
354 pub boundaries: BoundaryConfig,
355
356 /// 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`).
357 #[serde(default)]
358 pub flags: FlagsConfig,
359
360 /// 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.
361 #[serde(default)]
362 pub security: SecurityConfig,
363
364 /// 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.
365 #[serde(default)]
366 pub fix: FixConfig,
367
368 /// 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.
369 #[serde(default)]
370 pub resolve: ResolveConfig,
371
372 /// 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).
373 #[serde(default)]
374 pub production: ProductionConfig,
375
376 /// 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).
377 #[serde(default)]
378 pub plugins: Vec<String>,
379
380 /// Paths to declarative rule-pack files (JSON or JSONC), relative to the
381 /// project root. Each pack declares `banned-call`, `banned-import`, or
382 /// `banned-effect` rules that report as `policy-violation` findings. Packs
383 /// are pure data: no project code is executed. Invalid or missing packs
384 /// fail config load.
385 #[serde(default, skip_serializing_if = "Vec::is_empty")]
386 pub rule_packs: Vec<String>,
387
388 /// 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.
389 #[serde(default)]
390 pub dynamically_loaded: Vec<String>,
391
392 /// 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).
393 #[serde(default)]
394 pub overrides: Vec<ConfigOverride>,
395
396 /// 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.
397 #[serde(default, skip_serializing_if = "Option::is_none")]
398 pub codeowners: Option<String>,
399
400 /// 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).
401 #[serde(default)]
402 pub public_packages: Vec<String>,
403
404 /// 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.
405 #[serde(default, skip_serializing_if = "Option::is_none")]
406 pub regression: Option<RegressionConfig>,
407
408 /// 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.
409 #[serde(default, skip_serializing_if = "AuditConfig::is_empty")]
410 pub audit: AuditConfig,
411
412 /// 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.
413 #[serde(default)]
414 pub sealed: bool,
415
416 /// 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.
417 #[serde(default)]
418 pub include_entry_exports: bool,
419
420 /// When true, drops Nuxt convention-based entry-pattern fallbacks: component fallbacks are dropped unless nuxt.config declares components:, and composable/util fallbacks are dropped unless it declares imports:, so genuinely-unreferenced convention files surface as unused-file. Boolean, defaults to false; set it for a Nuxt project that has explicitly configured its auto-import directories. Synthesis of auto-import graph edges (resolving `<Card />` or `useUserStore()` to their convention files) happens regardless of this flag.
421 #[serde(default)]
422 pub auto_imports: bool,
423
424 /// 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`.
425 #[serde(default, skip_serializing_if = "CacheConfig::is_default")]
426 pub cache: CacheConfig,
427}
428
429/// Scopes `fallow security` catalogue behavior. An absent category block admits
430/// every catalogue category. `hardcoded-secret` is include-required and only
431/// runs when explicitly listed in `security.categories.include`.
432#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
433#[serde(deny_unknown_fields, rename_all = "camelCase")]
434pub struct SecurityConfig {
435 /// Include/exclude filter over category ids (e.g. `dangerous-html`).
436 #[serde(default, skip_serializing_if = "Option::is_none")]
437 pub categories: Option<SecurityCategories>,
438 /// Additional project-local names for HTTP request objects. These names
439 /// extend the built-in receiver allowlist for `*.query`, `*.params`, and
440 /// `*.body` source patterns. They do not replace the built-ins and do not
441 /// gate `*.searchParams`, which intentionally stays ungated.
442 #[serde(default, skip_serializing_if = "Vec::is_empty")]
443 pub request_receivers: Vec<String>,
444}
445
446impl SecurityConfig {
447 /// The configured `requestReceivers` trimmed, lowercased, and deduplicated
448 /// in first-seen order, with empty entries dropped; the form the matcher
449 /// compares receiver names against (matching is case-insensitive).
450 #[must_use]
451 pub fn normalized_request_receivers(&self) -> Vec<String> {
452 let mut receivers = Vec::new();
453 for receiver in &self.request_receivers {
454 let normalized = receiver.trim().to_ascii_lowercase();
455 if !normalized.is_empty() && !receivers.contains(&normalized) {
456 receivers.push(normalized);
457 }
458 }
459 receivers
460 }
461
462 /// False when any configured receiver is empty or whitespace-only, which
463 /// config validation reports as an error instead of silently dropping it.
464 #[must_use]
465 pub fn request_receivers_are_valid(&self) -> bool {
466 self.request_receivers
467 .iter()
468 .all(|receiver| !receiver.trim().is_empty())
469 }
470}
471
472/// Include/exclude lists scoping the active security categories. When `include`
473/// is set, only those categories are active; `exclude` removes categories from
474/// the admitted set. Both unset admits catalogue categories. `hardcoded-secret`
475/// still requires explicit inclusion.
476#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
477#[serde(deny_unknown_fields, rename_all = "camelCase")]
478pub struct SecurityCategories {
479 /// Catalogue category ids to admit. When set, all others are excluded.
480 #[serde(default, skip_serializing_if = "Option::is_none")]
481 pub include: Option<Vec<String>>,
482 /// Catalogue category ids to remove from the admitted set.
483 #[serde(default, skip_serializing_if = "Option::is_none")]
484 pub exclude: Option<Vec<String>>,
485}
486
487/// The `cache` config section: location and size ceiling of fallow's
488/// persistent caches (default directory `<root>/.fallow`).
489#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
490#[serde(deny_unknown_fields, rename_all = "camelCase")]
491pub struct CacheConfig {
492 /// Directory for fallow's persistent analysis cache. Relative paths resolve
493 /// from the project root.
494 #[serde(default, skip_serializing_if = "Option::is_none")]
495 pub dir: Option<PathBuf>,
496 /// Maximum size of the persistent extraction cache, in megabytes.
497 #[serde(default, skip_serializing_if = "Option::is_none")]
498 pub max_size_mb: Option<u32>,
499}
500
501impl CacheConfig {
502 /// True when neither field is set, so serialization can omit the section.
503 #[must_use]
504 pub fn is_default(&self) -> bool {
505 self.dir.is_none() && self.max_size_mb.is_none()
506 }
507}
508
509/// The analysis families production mode can be scoped to independently via
510/// the object form of the `production` config key.
511#[derive(Debug, Clone, Copy, PartialEq, Eq)]
512pub enum ProductionAnalysis {
513 /// Unused files/exports/dependencies detection.
514 DeadCode,
515 /// Complexity and health scoring.
516 Health,
517 /// Clone detection.
518 Dupes,
519}
520
521/// Value of the `production` config key: excludes test/spec/story/dev files
522/// from discovery, either globally or per analysis family.
523#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, JsonSchema)]
524#[serde(untagged)]
525pub enum ProductionConfig {
526 /// Boolean form applying to every analysis. The default is `false`.
527 Global(bool),
528 /// Object form (`{ deadCode?, health?, dupes? }`) scoping production mode
529 /// per analysis family.
530 PerAnalysis(PerAnalysisProductionConfig),
531}
532
533impl<'de> Deserialize<'de> for ProductionConfig {
534 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
535 where
536 D: Deserializer<'de>,
537 {
538 struct ProductionConfigVisitor;
539
540 impl<'de> serde::de::Visitor<'de> for ProductionConfigVisitor {
541 type Value = ProductionConfig;
542
543 fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
544 formatter.write_str("a boolean or per-analysis production config object")
545 }
546
547 fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
548 where
549 E: serde::de::Error,
550 {
551 Ok(ProductionConfig::Global(value))
552 }
553
554 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
555 where
556 A: serde::de::MapAccess<'de>,
557 {
558 PerAnalysisProductionConfig::deserialize(
559 serde::de::value::MapAccessDeserializer::new(map),
560 )
561 .map(ProductionConfig::PerAnalysis)
562 }
563 }
564
565 deserializer.deserialize_any(ProductionConfigVisitor)
566 }
567}
568
569impl Default for ProductionConfig {
570 fn default() -> Self {
571 Self::Global(false)
572 }
573}
574
575impl From<bool> for ProductionConfig {
576 fn from(value: bool) -> Self {
577 Self::Global(value)
578 }
579}
580
581impl Not for ProductionConfig {
582 type Output = bool;
583
584 fn not(self) -> Self::Output {
585 !self.any_enabled()
586 }
587}
588
589impl ProductionConfig {
590 /// Whether production mode applies to `analysis` under this config.
591 #[must_use]
592 pub const fn for_analysis(self, analysis: ProductionAnalysis) -> bool {
593 match self {
594 Self::Global(value) => value,
595 Self::PerAnalysis(config) => match analysis {
596 ProductionAnalysis::DeadCode => config.dead_code,
597 ProductionAnalysis::Health => config.health,
598 ProductionAnalysis::Dupes => config.dupes,
599 },
600 }
601 }
602
603 /// The boolean form's value; `false` for the per-analysis form, which has
604 /// no global toggle.
605 #[must_use]
606 pub const fn global(self) -> bool {
607 match self {
608 Self::Global(value) => value,
609 Self::PerAnalysis(_) => false,
610 }
611 }
612
613 /// Whether production mode is enabled for at least one analysis family.
614 #[must_use]
615 pub const fn any_enabled(self) -> bool {
616 match self {
617 Self::Global(value) => value,
618 Self::PerAnalysis(config) => config.dead_code || config.health || config.dupes,
619 }
620 }
621}
622
623/// Object form of the `production` config key, scoping production mode to
624/// individual analysis families in combined `fallow` and `fallow audit`.
625#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
626#[serde(default, deny_unknown_fields, rename_all = "camelCase")]
627pub struct PerAnalysisProductionConfig {
628 /// 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.
629 pub dead_code: bool,
630 /// 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.
631 pub health: bool,
632 /// 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.
633 pub dupes: bool,
634}
635
636/// The `audit` config section: in-repo defaults for `fallow audit`, each
637/// overridable by its matching CLI flag.
638#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
639#[serde(rename_all = "camelCase")]
640pub struct AuditConfig {
641 /// 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.
642 #[serde(default, skip_serializing_if = "AuditGate::is_default")]
643 pub gate: AuditGate,
644
645 /// 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.
646 #[serde(default, skip_serializing_if = "Option::is_none")]
647 pub css: Option<bool>,
648
649 /// 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.
650 #[serde(default, skip_serializing_if = "Option::is_none")]
651 pub css_deep: Option<bool>,
652
653 /// 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`.
654 #[serde(default, skip_serializing_if = "Option::is_none")]
655 pub dead_code_baseline: Option<String>,
656
657 /// 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.
658 #[serde(default, skip_serializing_if = "Option::is_none")]
659 pub health_baseline: Option<String>,
660
661 /// 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.
662 #[serde(default, skip_serializing_if = "Option::is_none")]
663 pub dupes_baseline: Option<String>,
664
665 /// 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.
666 #[serde(default, skip_serializing_if = "Option::is_none")]
667 pub cache_max_age_days: Option<u32>,
668
669 /// 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.
670 #[serde(default, skip_serializing_if = "Option::is_none")]
671 pub type_aware: Option<bool>,
672}
673
674impl AuditConfig {
675 /// True when every field is unset, so serialization can omit the section.
676 #[must_use]
677 pub fn is_empty(&self) -> bool {
678 self.gate.is_default()
679 && self.css.is_none()
680 && self.css_deep.is_none()
681 && self.dead_code_baseline.is_none()
682 && self.health_baseline.is_none()
683 && self.dupes_baseline.is_none()
684 && self.cache_max_age_days.is_none()
685 && self.type_aware.is_none()
686 }
687}
688
689/// Value of `audit.gate`: which findings drive the `fallow audit` verdict.
690#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize, JsonSchema)]
691#[serde(rename_all = "kebab-case")]
692pub enum AuditGate {
693 /// Fail only on findings the current changeset introduced, determined by
694 /// a base-snapshot attribution pass. The default.
695 #[default]
696 NewOnly,
697 /// Fail on every finding in changed files, skipping the attribution pass.
698 All,
699}
700
701impl AuditGate {
702 /// True for the default `new-only` gate, so serialization can omit it.
703 #[must_use]
704 pub const fn is_default(&self) -> bool {
705 matches!(self, Self::NewOnly)
706 }
707}
708
709/// The `regression` config section holding the saved issue-count baseline for
710/// the `--fail-on-regression` gate.
711#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
712#[serde(rename_all = "camelCase")]
713pub struct RegressionConfig {
714 /// 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.
715 #[serde(default, skip_serializing_if = "Option::is_none")]
716 pub baseline: Option<RegressionBaseline>,
717}
718
719/// Saved per-issue-type counts written by `--save-baseline` and compared by
720/// `--fail-on-regression`. Every count defaults to `0` when its key is missing,
721/// so hand-trimmed baselines stay loadable.
722#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
723#[serde(rename_all = "camelCase")]
724pub struct RegressionBaseline {
725 /// Compatibility identity for the analysis that produced these counts.
726 /// Missing values in existing configs are treated as syntactic.
727 #[serde(default)]
728 pub analysis_identity: fallow_types::semantic::SemanticAnalysisIdentity,
729 /// Baseline count across all issue types.
730 #[serde(default)]
731 pub total_issues: usize,
732 /// Baseline count of `unused-files` findings.
733 #[serde(default)]
734 pub unused_files: usize,
735 /// Baseline count of `unused-exports` findings.
736 #[serde(default)]
737 pub unused_exports: usize,
738 /// Baseline count of `unused-types` findings.
739 #[serde(default)]
740 pub unused_types: usize,
741 /// Baseline count of `unused-dependencies` findings.
742 #[serde(default)]
743 pub unused_dependencies: usize,
744 /// Baseline count of `unused-dev-dependencies` findings.
745 #[serde(default)]
746 pub unused_dev_dependencies: usize,
747 /// Baseline count of `unused-optional-dependencies` findings.
748 #[serde(default)]
749 pub unused_optional_dependencies: usize,
750 /// Baseline count of `unused-enum-members` findings.
751 #[serde(default)]
752 pub unused_enum_members: usize,
753 /// Baseline count of `unused-class-members` findings.
754 #[serde(default)]
755 pub unused_class_members: usize,
756 /// Baseline count of `unresolved-imports` findings.
757 #[serde(default)]
758 pub unresolved_imports: usize,
759 /// Baseline count of `unlisted-dependencies` findings.
760 #[serde(default)]
761 pub unlisted_dependencies: usize,
762 /// Baseline count of `duplicate-exports` findings.
763 #[serde(default)]
764 pub duplicate_exports: usize,
765 /// Baseline count of `circular-dependencies` findings.
766 #[serde(default)]
767 pub circular_dependencies: usize,
768 /// Baseline count of `re-export-cycle` findings.
769 #[serde(default)]
770 pub re_export_cycles: usize,
771 /// Baseline count of `type-only-dependencies` findings.
772 #[serde(default)]
773 pub type_only_dependencies: usize,
774 /// Baseline count of `test-only-dependencies` findings.
775 #[serde(default)]
776 pub test_only_dependencies: usize,
777 /// Baseline count of `dev-dependencies-in-production` findings.
778 #[serde(default)]
779 pub dev_dependencies_in_production: usize,
780 /// Baseline count of `boundary-violation` findings.
781 #[serde(default)]
782 pub boundary_violations: usize,
783 /// Baseline count of boundary-coverage-violation findings.
784 #[serde(default)]
785 pub boundary_coverage_violations: usize,
786 /// Baseline count of boundary-call-violation findings.
787 #[serde(default)]
788 pub boundary_call_violations: usize,
789 /// Baseline count of `policy-violation` findings.
790 #[serde(default)]
791 pub policy_violations: usize,
792}
793
794#[cfg(test)]
795mod tests {
796 use super::*;
797
798 #[test]
799 fn default_config_has_empty_collections() {
800 let config = FallowConfig::default();
801 assert!(config.schema.is_none());
802 assert!(config.extends.is_empty());
803 assert!(config.entry.is_empty());
804 assert!(config.ignore_patterns.is_empty());
805 assert!(config.ignore_findings.is_empty());
806 assert!(config.framework.is_empty());
807 assert!(config.workspaces.is_none());
808 assert!(config.ignore_dependencies.is_empty());
809 assert!(config.ignore_exports.is_empty());
810 assert!(config.used_class_members.is_empty());
811 assert!(config.plugins.is_empty());
812 assert!(config.dynamically_loaded.is_empty());
813 assert!(config.overrides.is_empty());
814 assert!(config.public_packages.is_empty());
815 assert_eq!(
816 config.fix.catalog.delete_preceding_comments,
817 CatalogPrecedingCommentPolicy::Auto
818 );
819 assert!(!config.production);
820 }
821
822 #[test]
823 fn default_config_rules_are_error() {
824 let config = FallowConfig::default();
825 assert_eq!(config.rules.unused_files, Severity::Error);
826 assert_eq!(config.rules.unused_exports, Severity::Error);
827 assert_eq!(config.rules.unused_dependencies, Severity::Error);
828 }
829
830 #[test]
831 fn default_config_duplicates_enabled() {
832 let config = FallowConfig::default();
833 assert!(config.duplicates.enabled);
834 assert_eq!(config.duplicates.min_tokens, 50);
835 assert_eq!(config.duplicates.min_lines, 5);
836 }
837
838 #[test]
839 fn default_config_health_thresholds() {
840 let config = FallowConfig::default();
841 assert_eq!(config.health.max_cyclomatic, 20);
842 assert_eq!(config.health.max_cognitive, 15);
843 }
844
845 #[test]
846 fn deserialize_empty_json_object() {
847 let config: FallowConfig = serde_json::from_str("{}").unwrap();
848 assert!(config.entry.is_empty());
849 assert!(!config.production);
850 assert!(!config.type_aware.enabled);
851 assert_eq!(config.type_aware.require, TypeAwareRequire::BestEffort);
852 }
853
854 #[test]
855 fn deserialize_type_aware_config() {
856 let config: FallowConfig = serde_json::from_str(
857 r#"{"typeAware":{"enabled":true,"projects":["tsconfig.app.json"],"require":"complete"}}"#,
858 )
859 .unwrap();
860
861 assert!(config.type_aware.enabled);
862 assert_eq!(config.type_aware.projects, ["tsconfig.app.json"]);
863 assert_eq!(config.type_aware.require, TypeAwareRequire::Complete);
864 }
865
866 #[test]
867 fn deserialize_type_aware_config_rejects_unknown_fields() {
868 let result = serde_json::from_str::<FallowConfig>(
869 r#"{"typeAware":{"enabled":true,"compilerDiagnostics":true}}"#,
870 );
871 assert!(result.is_err());
872 }
873
874 #[test]
875 fn deserialize_json_with_all_top_level_fields() {
876 let json = r#"{
877 "$schema": "./node_modules/fallow/schema.json",
878 "entry": ["src/main.ts"],
879 "ignorePatterns": ["generated/**"],
880 "ignoreFindings": ["**/*.test.ts", "!src/public/**"],
881 "ignoreDependencies": ["postcss"],
882 "production": true,
883 "plugins": ["custom-plugin.toml"],
884 "rules": {"unused-files": "warn"},
885 "duplicates": {"enabled": false},
886 "health": {"maxCyclomatic": 30}
887 }"#;
888 let config: FallowConfig = serde_json::from_str(json).unwrap();
889 assert_eq!(
890 config.schema.as_deref(),
891 Some("./node_modules/fallow/schema.json")
892 );
893 assert_eq!(config.entry, vec!["src/main.ts"]);
894 assert_eq!(config.ignore_patterns, vec!["generated/**"]);
895 assert_eq!(
896 config.ignore_findings,
897 vec!["**/*.test.ts", "!src/public/**"]
898 );
899 assert_eq!(config.ignore_dependencies, vec!["postcss"]);
900 assert!(config.production);
901 assert_eq!(config.plugins, vec!["custom-plugin.toml"]);
902 assert_eq!(config.rules.unused_files, Severity::Warn);
903 assert!(!config.duplicates.enabled);
904 assert_eq!(config.health.max_cyclomatic, 30);
905 }
906
907 #[test]
908 fn deserialize_json_deny_unknown_fields() {
909 let json = r#"{"unknownField": true}"#;
910 let result: Result<FallowConfig, _> = serde_json::from_str(json);
911 assert!(result.is_err(), "unknown fields should be rejected");
912 }
913
914 #[test]
915 fn ignore_findings_serialization_is_canonical_and_sparse() {
916 let default_value = serde_json::to_value(FallowConfig::default()).unwrap();
917 assert!(default_value.get("ignoreFindings").is_none());
918
919 let config = FallowConfig {
920 ignore_findings: vec!["**/*.test.ts".to_string(), "!src/public/**".to_string()],
921 ..Default::default()
922 };
923 let value = serde_json::to_value(config).unwrap();
924 assert_eq!(
925 value.get("ignoreFindings"),
926 Some(&serde_json::json!(["**/*.test.ts", "!src/public/**"]))
927 );
928 }
929
930 #[test]
931 fn ignore_findings_deserializes_from_toml() {
932 let config: FallowConfig =
933 toml::from_str(r#"ignoreFindings = ["**/*.test.ts", "!src/public/**"]"#).unwrap();
934
935 assert_eq!(
936 config.ignore_findings,
937 vec!["**/*.test.ts", "!src/public/**"]
938 );
939 }
940
941 #[test]
942 fn generic_ignore_alias_is_rejected() {
943 let result = serde_json::from_str::<FallowConfig>(r#"{"ignore": ["**/*.test.ts"]}"#);
944
945 assert!(result.is_err());
946 }
947
948 #[test]
949 fn deserialize_json_production_mode_default_false() {
950 let config: FallowConfig = serde_json::from_str("{}").unwrap();
951 assert!(!config.production);
952 }
953
954 #[test]
955 fn deserialize_json_production_mode_true() {
956 let config: FallowConfig = serde_json::from_str(r#"{"production": true}"#).unwrap();
957 assert!(config.production);
958 }
959
960 #[test]
961 fn deserialize_json_per_analysis_production_mode() {
962 let config: FallowConfig = serde_json::from_str(
963 r#"{"production": {"deadCode": false, "health": true, "dupes": false}}"#,
964 )
965 .unwrap();
966 assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
967 assert!(config.production.for_analysis(ProductionAnalysis::Health));
968 assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
969 }
970
971 #[test]
972 fn deserialize_json_per_analysis_production_mode_rejects_unknown_fields() {
973 let err = serde_json::from_str::<FallowConfig>(r#"{"production": {"healthTypo": true}}"#)
974 .unwrap_err();
975 assert!(
976 err.to_string().contains("healthTypo"),
977 "error should name the unknown field: {err}"
978 );
979 }
980
981 #[test]
982 fn deserialize_json_dynamically_loaded() {
983 let json = r#"{"dynamicallyLoaded": ["plugins/**/*.ts", "locales/**/*.json"]}"#;
984 let config: FallowConfig = serde_json::from_str(json).unwrap();
985 assert_eq!(
986 config.dynamically_loaded,
987 vec!["plugins/**/*.ts", "locales/**/*.json"]
988 );
989 }
990
991 #[test]
992 fn deserialize_json_dynamically_loaded_defaults_empty() {
993 let config: FallowConfig = serde_json::from_str("{}").unwrap();
994 assert!(config.dynamically_loaded.is_empty());
995 }
996
997 #[test]
998 fn deserialize_json_fix_catalog_delete_preceding_comments() {
999 let config: FallowConfig =
1000 serde_json::from_str(r#"{"fix": {"catalog": {"deletePrecedingComments": "always"}}}"#)
1001 .unwrap();
1002 assert_eq!(
1003 config.fix.catalog.delete_preceding_comments,
1004 CatalogPrecedingCommentPolicy::Always
1005 );
1006 }
1007
1008 #[test]
1009 fn deserialize_json_fix_catalog_delete_preceding_comments_rejects_unknown_policy() {
1010 let err = serde_json::from_str::<FallowConfig>(
1011 r#"{"fix": {"catalog": {"deletePrecedingComments": "sometimes"}}}"#,
1012 )
1013 .unwrap_err();
1014 assert!(
1015 err.to_string().contains("sometimes"),
1016 "error should name the bad policy: {err}"
1017 );
1018 }
1019
1020 #[test]
1021 fn deserialize_json_used_class_members_supports_strings_and_scoped_rules() {
1022 let json = r#"{
1023 "usedClassMembers": [
1024 "agInit",
1025 { "implements": "ICellRendererAngularComp", "members": ["refresh"] },
1026 { "extends": "BaseCommand", "implements": "CanActivate", "members": ["execute"] }
1027 ]
1028 }"#;
1029 let config: FallowConfig = serde_json::from_str(json).unwrap();
1030 assert_eq!(
1031 config.used_class_members,
1032 vec![
1033 UsedClassMemberRule::from("agInit"),
1034 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1035 extends: None,
1036 implements: Some("ICellRendererAngularComp".to_string()),
1037 members: vec!["refresh".to_string()],
1038 }),
1039 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1040 extends: Some("BaseCommand".to_string()),
1041 implements: Some("CanActivate".to_string()),
1042 members: vec!["execute".to_string()],
1043 }),
1044 ]
1045 );
1046 }
1047
1048 #[test]
1049 fn deserialize_toml_minimal() {
1050 let toml_str = r#"
1051entry = ["src/index.ts"]
1052production = true
1053"#;
1054 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1055 assert_eq!(config.entry, vec!["src/index.ts"]);
1056 assert!(config.production);
1057 }
1058
1059 #[test]
1060 fn workspaces_packages_key_is_accepted_as_patterns_alias() {
1061 // An older `fallow init --toml` wrote `[workspaces]` with a `packages`
1062 // key; the back-compat serde alias keeps those existing configs scoping
1063 // instead of silently dropping the (unknown) key and losing the patterns.
1064 let config: FallowConfig =
1065 toml::from_str("[workspaces]\npackages = [\"packages/*\", \"apps/*\"]").unwrap();
1066 assert_eq!(
1067 config.workspaces.map(|w| w.patterns).unwrap_or_default(),
1068 vec!["packages/*".to_string(), "apps/*".to_string()],
1069 "the `packages` alias must populate `patterns`"
1070 );
1071 }
1072
1073 #[test]
1074 fn deserialize_toml_per_analysis_production_mode() {
1075 let toml_str = r"
1076[production]
1077deadCode = false
1078health = true
1079dupes = false
1080";
1081 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1082 assert!(!config.production.for_analysis(ProductionAnalysis::DeadCode));
1083 assert!(config.production.for_analysis(ProductionAnalysis::Health));
1084 assert!(!config.production.for_analysis(ProductionAnalysis::Dupes));
1085 }
1086
1087 #[test]
1088 fn deserialize_toml_per_analysis_production_mode_rejects_unknown_fields() {
1089 let err = toml::from_str::<FallowConfig>(
1090 r"
1091[production]
1092healthTypo = true
1093",
1094 )
1095 .unwrap_err();
1096 assert!(
1097 err.to_string().contains("healthTypo"),
1098 "error should name the unknown field: {err}"
1099 );
1100 }
1101
1102 #[test]
1103 fn deserialize_toml_with_inline_framework() {
1104 let toml_str = r#"
1105[[framework]]
1106name = "my-framework"
1107enablers = ["my-framework-pkg"]
1108entryPoints = ["src/routes/**/*.tsx"]
1109"#;
1110 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1111 assert_eq!(config.framework.len(), 1);
1112 assert_eq!(config.framework[0].name, "my-framework");
1113 assert_eq!(config.framework[0].enablers, vec!["my-framework-pkg"]);
1114 assert_eq!(
1115 config.framework[0].entry_points,
1116 vec!["src/routes/**/*.tsx"]
1117 );
1118 }
1119
1120 #[test]
1121 fn deserialize_toml_fix_catalog_delete_preceding_comments() {
1122 let toml_str = r#"
1123[fix.catalog]
1124deletePrecedingComments = "never"
1125"#;
1126 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1127 assert_eq!(
1128 config.fix.catalog.delete_preceding_comments,
1129 CatalogPrecedingCommentPolicy::Never
1130 );
1131 }
1132
1133 #[test]
1134 fn deserialize_toml_with_workspace_config() {
1135 let toml_str = r#"
1136[workspaces]
1137patterns = ["packages/*", "apps/*"]
1138"#;
1139 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1140 assert!(config.workspaces.is_some());
1141 let ws = config.workspaces.unwrap();
1142 assert_eq!(ws.patterns, vec!["packages/*", "apps/*"]);
1143 }
1144
1145 #[test]
1146 fn deserialize_toml_with_ignore_exports() {
1147 let toml_str = r#"
1148[[ignoreExports]]
1149file = "src/types/**/*.ts"
1150exports = ["*"]
1151"#;
1152 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1153 assert_eq!(config.ignore_exports.len(), 1);
1154 assert_eq!(config.ignore_exports[0].file, "src/types/**/*.ts");
1155 assert_eq!(config.ignore_exports[0].exports, vec!["*"]);
1156 }
1157
1158 #[test]
1159 fn deserialize_toml_used_class_members_supports_scoped_rules() {
1160 let toml_str = r#"
1161usedClassMembers = [
1162 { implements = "ICellRendererAngularComp", members = ["refresh"] },
1163 { extends = "BaseCommand", members = ["execute"] },
1164]
1165"#;
1166 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1167 assert_eq!(
1168 config.used_class_members,
1169 vec![
1170 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1171 extends: None,
1172 implements: Some("ICellRendererAngularComp".to_string()),
1173 members: vec!["refresh".to_string()],
1174 }),
1175 UsedClassMemberRule::Scoped(ScopedUsedClassMemberRule {
1176 extends: Some("BaseCommand".to_string()),
1177 implements: None,
1178 members: vec!["execute".to_string()],
1179 }),
1180 ]
1181 );
1182 }
1183
1184 #[test]
1185 fn deserialize_json_used_class_members_rejects_unconstrained_scoped_rules() {
1186 let result = serde_json::from_str::<FallowConfig>(
1187 r#"{"usedClassMembers":[{"members":["refresh"]}]}"#,
1188 );
1189 assert!(
1190 result.is_err(),
1191 "unconstrained scoped rule should be rejected"
1192 );
1193 }
1194
1195 #[test]
1196 fn deserialize_ignore_exports_used_in_file_bool() {
1197 let config: FallowConfig =
1198 serde_json::from_str(r#"{"ignoreExportsUsedInFile":true}"#).unwrap();
1199
1200 assert!(config.ignore_exports_used_in_file.suppresses(false));
1201 assert!(config.ignore_exports_used_in_file.suppresses(true));
1202 }
1203
1204 #[test]
1205 fn deserialize_ignore_exports_used_in_file_kind_form() {
1206 let config: FallowConfig =
1207 serde_json::from_str(r#"{"ignoreExportsUsedInFile":{"type":true}}"#).unwrap();
1208
1209 assert!(!config.ignore_exports_used_in_file.suppresses(false));
1210 assert!(config.ignore_exports_used_in_file.suppresses(true));
1211 }
1212
1213 #[test]
1214 fn deserialize_toml_deny_unknown_fields() {
1215 let toml_str = r"bogus_field = true";
1216 let result: Result<FallowConfig, _> = toml::from_str(toml_str);
1217 assert!(result.is_err(), "unknown fields should be rejected");
1218 }
1219
1220 #[test]
1221 fn json_serialize_roundtrip() {
1222 let config = FallowConfig {
1223 entry: vec!["src/main.ts".to_string()],
1224 production: true.into(),
1225 ..FallowConfig::default()
1226 };
1227 let json = serde_json::to_string(&config).unwrap();
1228 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1229 assert_eq!(restored.entry, vec!["src/main.ts"]);
1230 assert!(restored.production);
1231 }
1232
1233 #[test]
1234 fn schema_field_not_serialized() {
1235 let config = FallowConfig {
1236 schema: Some("https://example.com/schema.json".to_string()),
1237 ..FallowConfig::default()
1238 };
1239 let json = serde_json::to_string(&config).unwrap();
1240 assert!(
1241 !json.contains("$schema"),
1242 "schema field should be skipped in serialization"
1243 );
1244 }
1245
1246 #[test]
1247 fn extends_field_not_serialized() {
1248 let config = FallowConfig {
1249 extends: vec!["base.json".to_string()],
1250 ..FallowConfig::default()
1251 };
1252 let json = serde_json::to_string(&config).unwrap();
1253 assert!(
1254 !json.contains("extends"),
1255 "extends field should be skipped in serialization"
1256 );
1257 }
1258
1259 #[test]
1260 fn regression_config_deserialize_json() {
1261 let json = r#"{
1262 "regression": {
1263 "baseline": {
1264 "totalIssues": 42,
1265 "unusedFiles": 10,
1266 "unusedExports": 5,
1267 "circularDependencies": 2
1268 }
1269 }
1270 }"#;
1271 let config: FallowConfig = serde_json::from_str(json).unwrap();
1272 let regression = config.regression.unwrap();
1273 let baseline = regression.baseline.unwrap();
1274 assert_eq!(baseline.total_issues, 42);
1275 assert_eq!(baseline.unused_files, 10);
1276 assert_eq!(baseline.unused_exports, 5);
1277 assert_eq!(baseline.circular_dependencies, 2);
1278 assert_eq!(baseline.unused_types, 0);
1279 assert_eq!(baseline.boundary_violations, 0);
1280 }
1281
1282 #[test]
1283 fn regression_config_defaults_to_none() {
1284 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1285 assert!(config.regression.is_none());
1286 }
1287
1288 #[test]
1289 fn regression_baseline_all_zeros_by_default() {
1290 let baseline = RegressionBaseline::default();
1291 assert_eq!(baseline.total_issues, 0);
1292 assert_eq!(baseline.unused_files, 0);
1293 assert_eq!(baseline.unused_exports, 0);
1294 assert_eq!(baseline.unused_types, 0);
1295 assert_eq!(baseline.unused_dependencies, 0);
1296 assert_eq!(baseline.unused_dev_dependencies, 0);
1297 assert_eq!(baseline.unused_optional_dependencies, 0);
1298 assert_eq!(baseline.unused_enum_members, 0);
1299 assert_eq!(baseline.unused_class_members, 0);
1300 assert_eq!(baseline.unresolved_imports, 0);
1301 assert_eq!(baseline.unlisted_dependencies, 0);
1302 assert_eq!(baseline.duplicate_exports, 0);
1303 assert_eq!(baseline.circular_dependencies, 0);
1304 assert_eq!(baseline.type_only_dependencies, 0);
1305 assert_eq!(baseline.test_only_dependencies, 0);
1306 assert_eq!(baseline.boundary_violations, 0);
1307 }
1308
1309 #[test]
1310 fn regression_config_serialize_roundtrip() {
1311 let baseline = RegressionBaseline {
1312 total_issues: 100,
1313 unused_files: 20,
1314 unused_exports: 30,
1315 ..RegressionBaseline::default()
1316 };
1317 let regression = RegressionConfig {
1318 baseline: Some(baseline),
1319 };
1320 let config = FallowConfig {
1321 regression: Some(regression),
1322 ..FallowConfig::default()
1323 };
1324 let json = serde_json::to_string(&config).unwrap();
1325 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1326 let restored_baseline = restored.regression.unwrap().baseline.unwrap();
1327 assert_eq!(restored_baseline.total_issues, 100);
1328 assert_eq!(restored_baseline.unused_files, 20);
1329 assert_eq!(restored_baseline.unused_exports, 30);
1330 assert_eq!(restored_baseline.unused_types, 0);
1331 }
1332
1333 #[test]
1334 fn regression_config_empty_baseline_deserialize() {
1335 let json = r#"{"regression": {}}"#;
1336 let config: FallowConfig = serde_json::from_str(json).unwrap();
1337 let regression = config.regression.unwrap();
1338 assert!(regression.baseline.is_none());
1339 }
1340
1341 #[test]
1342 fn regression_baseline_not_serialized_when_none() {
1343 let config = FallowConfig {
1344 regression: None,
1345 ..FallowConfig::default()
1346 };
1347 let json = serde_json::to_string(&config).unwrap();
1348 assert!(
1349 !json.contains("regression"),
1350 "regression should be skipped when None"
1351 );
1352 }
1353
1354 #[test]
1355 fn deserialize_json_with_overrides() {
1356 let json = r#"{
1357 "overrides": [
1358 {
1359 "files": ["*.test.ts", "*.spec.ts"],
1360 "rules": {
1361 "unused-exports": "off",
1362 "unused-files": "warn"
1363 }
1364 }
1365 ]
1366 }"#;
1367 let config: FallowConfig = serde_json::from_str(json).unwrap();
1368 assert_eq!(config.overrides.len(), 1);
1369 assert_eq!(config.overrides[0].files.len(), 2);
1370 assert_eq!(
1371 config.overrides[0].rules.unused_exports,
1372 Some(Severity::Off)
1373 );
1374 assert_eq!(config.overrides[0].rules.unused_files, Some(Severity::Warn));
1375 }
1376
1377 #[test]
1378 fn deserialize_json_with_boundaries() {
1379 let json = r#"{
1380 "boundaries": {
1381 "preset": "layered"
1382 }
1383 }"#;
1384 let config: FallowConfig = serde_json::from_str(json).unwrap();
1385 assert_eq!(config.boundaries.preset, Some(BoundaryPreset::Layered));
1386 }
1387
1388 #[test]
1389 fn deserialize_toml_with_regression_baseline() {
1390 let toml_str = r"
1391[regression.baseline]
1392totalIssues = 50
1393unusedFiles = 10
1394unusedExports = 15
1395";
1396 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1397 let baseline = config.regression.unwrap().baseline.unwrap();
1398 assert_eq!(baseline.total_issues, 50);
1399 assert_eq!(baseline.unused_files, 10);
1400 assert_eq!(baseline.unused_exports, 15);
1401 }
1402
1403 #[test]
1404 fn deserialize_toml_with_overrides() {
1405 let toml_str = r#"
1406[[overrides]]
1407files = ["*.test.ts"]
1408
1409[overrides.rules]
1410unused-exports = "off"
1411
1412[[overrides]]
1413files = ["*.stories.tsx"]
1414
1415[overrides.rules]
1416unused-files = "off"
1417"#;
1418 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1419 assert_eq!(config.overrides.len(), 2);
1420 assert_eq!(
1421 config.overrides[0].rules.unused_exports,
1422 Some(Severity::Off)
1423 );
1424 assert_eq!(config.overrides[1].rules.unused_files, Some(Severity::Off));
1425 }
1426
1427 #[test]
1428 fn regression_config_default_is_none_baseline() {
1429 let config = RegressionConfig::default();
1430 assert!(config.baseline.is_none());
1431 }
1432
1433 #[test]
1434 fn deserialize_json_multiple_ignore_export_rules() {
1435 let json = r#"{
1436 "ignoreExports": [
1437 {"file": "src/types/**/*.ts", "exports": ["*"]},
1438 {"file": "src/constants.ts", "exports": ["FOO", "BAR"]},
1439 {"file": "src/index.ts", "exports": ["default"]}
1440 ]
1441 }"#;
1442 let config: FallowConfig = serde_json::from_str(json).unwrap();
1443 assert_eq!(config.ignore_exports.len(), 3);
1444 assert_eq!(config.ignore_exports[2].exports, vec!["default"]);
1445 }
1446
1447 #[test]
1448 fn deserialize_json_public_packages_camel_case() {
1449 let json = r#"{"publicPackages": ["@myorg/shared-lib", "@myorg/utils"]}"#;
1450 let config: FallowConfig = serde_json::from_str(json).unwrap();
1451 assert_eq!(
1452 config.public_packages,
1453 vec!["@myorg/shared-lib", "@myorg/utils"]
1454 );
1455 }
1456
1457 #[test]
1458 fn deserialize_json_public_packages_rejects_snake_case() {
1459 let json = r#"{"public_packages": ["@myorg/shared-lib"]}"#;
1460 let result: Result<FallowConfig, _> = serde_json::from_str(json);
1461 assert!(
1462 result.is_err(),
1463 "snake_case should be rejected by deny_unknown_fields + rename_all camelCase"
1464 );
1465 }
1466
1467 #[test]
1468 fn deserialize_json_public_packages_empty() {
1469 let config: FallowConfig = serde_json::from_str("{}").unwrap();
1470 assert!(config.public_packages.is_empty());
1471 }
1472
1473 #[test]
1474 fn deserialize_toml_public_packages() {
1475 let toml_str = r#"
1476publicPackages = ["@myorg/shared-lib", "@myorg/ui"]
1477"#;
1478 let config: FallowConfig = toml::from_str(toml_str).unwrap();
1479 assert_eq!(
1480 config.public_packages,
1481 vec!["@myorg/shared-lib", "@myorg/ui"]
1482 );
1483 }
1484
1485 #[test]
1486 fn public_packages_serialize_roundtrip() {
1487 let config = FallowConfig {
1488 public_packages: vec!["@myorg/shared-lib".to_string()],
1489 ..FallowConfig::default()
1490 };
1491 let json = serde_json::to_string(&config).unwrap();
1492 let restored: FallowConfig = serde_json::from_str(&json).unwrap();
1493 assert_eq!(restored.public_packages, vec!["@myorg/shared-lib"]);
1494 }
1495}