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