Config file
Find each top-level key of the fallow config file, with its type and a link to its full entry.
The config file holds the settings of fallow. How config works explains where fallow finds the file and how files merge.
Files and entry points
| Key | Type | Description |
|---|---|---|
$schema | string | 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 fallow does not write it back when it saves a config. |
minimumVersion | string | The lowest fallow version this config is written for, as MAJOR.MINOR.PATCH. |
extends | string or string[] | A single parent config source, or an ordered array of them, to inherit before this file's own keys apply; each source is a file-relative path, an npm:<package> specifier, or an https:// URL (http:// is rejected), deep-merged in order so objects merge field-by-field while arrays and scalars in this file replace the parent's, with a cycle guard and a depth limit of 10 levels. |
entry | string[] | 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. |
ignorePatterns | string[] | 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. |
supportEntry | string[] | An array of project-root-relative glob patterns whose matching files are support entry points: dev scripts, tooling and setup files that run outside production. |
resolve | object | Configures the module resolver. |
production | boolean or object | Enables production mode, which excludes test/spec/story/dev files from discovery and forces unused-dev-dependencies and unused-optional-dependencies to off. |
dynamicallyLoaded | string[] | 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. |
markupExtensions | string[] | An array of file extensions, without the leading dot, for server-side template files whose text counts as CSS class references for the unreferenced-css-class finding of fallow health --css. |
codeowners | string | 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). |
publicPackages | string[] | 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. |
sealed | boolean | 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. |
includeEntryExports | boolean | When true, fallow checks the exports of every entry-point file for unused exports. |
autoImports | boolean | When true, drops Nuxt convention-based entry-pattern fallbacks so genuinely-unreferenced convention files surface as unused-file. |
failOnParseError | boolean | When true, the run fails with exit code 1 if fallow could not parse a source file cleanly (a source-parse-degraded or source-nesting-too-deep entry in workspace_diagnostics[]), and the parse-error entry of gate_outcomes names each such file. |
cache | object | Overrides the location and size ceiling of fallow's persistent extraction cache (default .fallow/cache.bin under the project root). |
Dead code and dependencies
| Key | Type | Description |
|---|---|---|
ignoreFindings | string[] | 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. |
ignoreDependencies | string[] | A list of package names or package-name globs excluded from both unused-dependency and unlisted-dependency detection, so a runtime-provided or otherwise-untracked package (e.g. bun:sqlite, a peer supplied at deploy time) is never flagged as unused when declared nor as unlisted when imported. |
ignoreBinaries | string[] | A list of binary names or name globs that the unlisted-binaries rule does not report. |
ignoreCommandEntries | string[] | A list of command names whose file arguments fallow does not make entry points. |
ignoreUnresolvedImports | string[] | 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. |
ignoreExports | object[] | A list of per-file rules that exempt named exports from unused-export and from duplicate-exports grouping for files matching a glob. |
ignoreCatalogReferences | object[] | 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. |
ignoreDependencyOverrides | object[] | A list of rules that suppress unused-dependency-override and misconfigured-dependency-override findings for override entries: pnpm overrides in pnpm-workspace.yaml or package.json, npm and bun overrides, and bun resolutions; config-only, matched against the override's target package. |
ignoreExportsUsedInFile | boolean or object | 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. |
ignoreDecorators | string[] | 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). |
usedClassMembers | (string or object)[] | 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. |
unusedComponentProps | object | Options for the unused-component-props rule. |
effect | object | Options for projects that use the Effect library. |
sharedStateAllowlist | string[][] | Global slots that fallow architecture --shared-state leaves out of its inventory. |
fix | object | Configures fallow fix behavior. |
Rules and gates
| Key | Type | Description |
|---|---|---|
rules | object | 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" }). |
overrides | object[] | 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. |
regression | object | 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. |
audit | object | Sets in-repo defaults for fallow audit (the changed-files quality gate) so CLI flags need not repeat per run. |
showCascade | boolean | When true, the report keeps the unused exports, unused types, unused class members and unused enum members of a file that is an unused file. |
Duplication
| Key | Type | Description |
|---|---|---|
duplicates | object | Configures clone detection. |
similarCode | object | Configures the explicit local similar-code candidate workflow: threshold (0.80, model-specific cosine floor), minLines (3), and additional ignore globs. |
Health, tests and type-aware analysis
| Key | Type | Description |
|---|---|---|
mutation | object | Configures the explicit fallow mutation workflow: runner (auto or vitest), operators (kebab-case names, default the default set), minScore (0 to 100; a lower score exits with code 1), and concurrency (half the logical cores). |
health | object | Sets complexity and health thresholds for fallow health (also applied in combined fallow and fallow audit). |
typeAware | object | Opts into TypeScript semantic analysis for project-wide symbol use, provenance, API surface, symbol impact, and public-signature coupling. |
Boundaries and architecture
| Key | Type | Description |
|---|---|---|
circularDependencies | object | Options for the circular-dependencies rule: ignoreLazyImports and allow, a list of accepted cycles. |
boundaries | object | 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). |
Workspaces
| Key | Type | Description |
|---|---|---|
workspaces | object | Monorepo workspace configuration. |
Plugins and frameworks
| Key | Type | Description |
|---|---|---|
framework | object[] | 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); an entry with neither never activates, and config load warns. |
plugins | string[] | 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. |
rulePacks | string[] | Paths to declarative rule-pack files (JSON or JSONC), relative to the project root. |