Skip to content
Fallow home
All docs pages

Docs home

Config: dead code and dependencies

Find the fallow config keys for dead code and dependencies, with type, default, allowed values and description.

The config file holds the settings of fallow. How config works explains where fallow finds the file and how files merge.

ignoreFindings

  • Type: string[]
  • Default: []

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. The human output names each pattern that matched no finding in the run. Positive patterns select paths to hide; !-prefixed patterns keep matching paths reportable, and a negated-only array reports only those exception paths. A finding with multiple source owners is hidden only when every owner matches, so a cycle, duplicate-export group, or unlisted dependency with any reportable location remains visible. Architecture, policy, suppression-hygiene, and framework-correctness findings remain visible even when a referenced path matches, as do manifest-owned findings that no source file owns: unused dependencies, unused dev and optional dependencies, catalog entries, and dependency overrides. Use ignorePatterns instead when a generated or vendored file must not be analyzed at all. A matching file that parses with errors reports no source-parse-degraded diagnostic, and its partial parse does not mark other findings as incomplete; use this only for files that are broken on purpose, such as syntax-error test fixtures. A single * stays within one path segment; use ** to match across directories.

ignoreDependencies

  • Type: string[]
  • Default: []

A list of package names or package-name globs excluded from both unused-dependency and unlisted-dependency detection, so a runtime-provided or otherwise-untracked package (e.g. bun:sqlite, a peer supplied at deploy time) is never flagged as unused when declared nor as unlisted when imported. Set it for packages fallow cannot observe being used and cannot observe being declared. An entry without glob characters matches the package name exactly; an entry with *, ?, [ or { is a glob in the ignorePatterns syntax matched against the package name, so @acme/* covers every package in the @acme scope. The human output names each entry that hid no dependency finding and each glob that matched no declared dependency in the run.

ignoreBinaries

  • Type: string[]
  • Default: []

A list of binary names or name globs that the unlisted-binaries rule does not report. Set it for a binary that the operating system, the CI image, or a tool outside node_modules provides (e.g. ["gnome-extensions", "tailscale"]). An entry without glob characters matches the binary name exactly; an entry with *, ?, [ or { is a glob matched against the binary name, so xcrun* covers every name that starts with xcrun. Fallow already skips shell builtins and a fixed list of common operating-system tools (such as git, ssh-keygen, curl, and ffmpeg).

ignoreCommandEntries

  • Type: string[]
  • Default: []

A list of command names whose file arguments fallow does not make entry points. Fallow reads commands in package.json scripts (root and workspace packages), CI files (GitHub Actions and GitLab CI), Dockerfiles, Procfiles, and fly.toml files, and a file that a command names (such as node scripts/seed.ts) normally becomes an entry point. A listed command still counts as a used dependency, and its --config file is still tracked. Formatters and linters (ESLint, Prettier, Oxlint, Oxfmt, Biome, Stylelint, and similar tools) never make their targets entry points, so they do not need to be listed. Set it for a command whose file arguments are data, not code that runs (e.g. ["my-codegen"]), or use ["*"] to turn off entry points from all commands and declare real entries in entry. A name matches the command after environment, package-manager, and wrapper prefixes (npx, pnpm exec, yarn run, varlock run --), by exact file name; * is the only wildcard.

ignoreUnresolvedImports

  • Type: string[]
  • Default: []

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. An invalid glob is a config error.

ignoreExports

  • Type: object[]
  • Default: []

A list of per-file rules that exempt named exports from unused-export and from duplicate-exports grouping for files matching a glob. Each entry is { file: <glob>, exports: [<name>, ...] } where exports: ["*"] exempts every export in the file and a name list exempts only those names; built for component-library barrels (shadcn/Radix/bits-ui index.ts) that intentionally re-export the same short names across many files. A single * stays within one path segment; use ** to match across directories. An invalid file glob is a config error. fallow fix can add an entry for a duplicate export.

KeyTypeDefault
filestring
exportsstring[]

ignoreExports[].file

  • Type: string

Glob pattern for files. A single * stays within one path segment; use ** to match across directories.

ignoreExports[].exports

  • Type: string[]

Export names to ignore (* for all).

ignoreCatalogReferences

  • Type: object[]
  • Default: []

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. An invalid consumer glob is a config error.

KeyTypeDefault
packagestring
catalogstring
consumerstring

ignoreCatalogReferences[].package

  • Type: string

Required exact package name whose unresolved-catalog-reference finding this rule suppresses; compared by string equality against the referenced package, so one rule targets one package's catalog reference (further narrowed by the optional catalog and consumer filters, all of which must match).

ignoreCatalogReferences[].catalog

  • Type: string (optional)

Optional catalog-name filter: when set, the rule suppresses only references to this exact catalog name (string equality), and when omitted it applies regardless of which catalog is referenced. Use it to scope suppression to one catalog (e.g. "react18") while leaving other catalog references for the same package reportable.

ignoreCatalogReferences[].consumer

  • Type: string (optional)

Optional glob matched against the consuming workspace package.json path (compiled into a glob matcher at config load): when set, the rule suppresses the finding only for consumers whose path matches, and when omitted it applies to every consumer. Use it to suppress a catalog reference in one specific workspace during a staged migration. A single * stays within one path segment; use ** to match across directories.

ignoreDependencyOverrides

  • Type: object[]
  • Default: []

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. Each entry needs a package (exact match) plus an optional source to scope the suppression to "pnpm-workspace.yaml" or "package.json".

KeyTypeDefault
packagestring
sourcestring

ignoreDependencyOverrides[].package

  • Type: string

Required exact package name whose unused-dependency-override or misconfigured-dependency-override finding this rule suppresses; compared by string equality against the override's target package, so one rule targets one override entry (further narrowable with the optional source filter).

ignoreDependencyOverrides[].source

  • Type: string (optional)

Optional source filter matched by exact string equality against the override's declaring-file label: set it to "pnpm-workspace.yaml" or "package.json" to scope the suppression to overrides declared in that file, or omit it to suppress the package's override regardless of where it is declared.

ignoreExportsUsedInFile

  • Type: 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. 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.

KeyTypeDefault
typebooleanfalse
interfacebooleanfalse

ignoreExportsUsedInFile.type

  • Type: boolean
  • Default: false

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.

ignoreExportsUsedInFile.interface

  • Type: boolean
  • Default: false

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.

ignoreDecorators

  • Type: string[]
  • Default: []

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.

usedClassMembers

  • Type: (string or object)[]
  • Default: []

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.

KeyTypeDefault
extendsstring
implementsstring
membersstring[]

usedClassMembers[].extends

  • Type: string (optional)

Only apply when the class extends this parent class name.

usedClassMembers[].implements

  • Type: string (optional)

Only apply when the class implements this interface name.

usedClassMembers[].members

  • Type: string[]

Member names or glob patterns that should be treated as framework-used.

unusedComponentProps

  • Type: object

Options for the unused-component-props rule. It has one key, 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).

KeyTypeDefault
ignorePatternstring

unusedComponentProps.ignorePattern

  • Type: string (optional)

Regex matched against each declared prop's local destructure binding name (e.g. _stage in let { stage: _stage } = $props()), which falls back to the public prop name when there is no alias. A prop whose local name matches is treated as intentionally unused and never reported as unused-component-props. Matching is unanchored (substring), like ESLint's RegExp.test, so anchor with ^_ to match a leading underscore. Compiled and validated at config load (an invalid regex fails load). Applies to Vue, Svelte, Astro, and React/Preact props.

effect

  • Type: object

Options for projects that use the Effect library. Its one key is schemaExportsAsTypes. Set { "schemaExportsAsTypes": true } to report an unused exported Effect schema (a class that extends Schema.Class, Schema.TaggedClass, Schema.TaggedError and the other Schema class factories, or a const such as Schema.Struct({...}) or Schema.String.pipe(Schema.brand("Id"))) as an unused type under the unused-types rule, not as an unused export, so "unused-types": "off" hides it. Schema must come from effect, effect/Schema or @effect/schema. A re-export of a schema from another module also counts. In a module that imports Effect, a chain on an imported schema (Imported.pipe(Schema.brand("Id")), Imported.annotations({...})) and an alias (export const Copy = Imported) also count. Default false leaves every report unchanged.

KeyTypeDefault
schemaExportsAsTypesbooleanfalse

effect.schemaExportsAsTypes

  • Type: boolean
  • Default: false

Report an unused exported Effect schema as an unused type, under the unused-types rule, and not as an unused export. An Effect schema defines a runtime value and a type (typeof User.Type), so a team that keeps exported types as contracts can keep schemas too. With "unused-types": "off", fallow does not report them. A schema is a class that extends a Schema class factory (Schema.Class, Schema.TaggedClass, Schema.TaggedError, Schema.TaggedRequest, Schema.Error, Schema.Opaque), or a const whose value is a Schema constructor, member or pipe chain (Schema.Struct({...}), Schema.String.pipe(Schema.brand("Id"))). Each pipe argument must be a Schema transform. Schema must come from effect, effect/Schema or @effect/schema. Default false.

sharedStateAllowlist

  • Type: string[][]
  • Default: []

Global slots that fallow architecture --shared-state leaves out of its inventory. Each entry is an exact pair of a global root (window, globalThis, self or global) and a direct slot, for example ["window", "analyticsQueue"].

fix

  • Type: object

Configures fallow fix behavior. It holds one nested section, catalog, 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.

KeyTypeDefault
catalogobject

fix.catalog

  • Type: object

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.

KeyTypeDefault
deletePrecedingCommentsstring"auto"

fix.catalog.deletePrecedingComments

  • Type: string
  • Default: "auto"

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.

Allowed values:

  • auto: Delete the adjacent comment block only when heuristics attribute it to the entry (preceded by a blank line or directly under the catalog header) and it is not a section banner. The default.
  • always: Always delete the adjacent comment block with the entry.
  • never: Never delete preceding comments.