Config: plugins and frameworks
Find the fallow config keys for plugins and frameworks, 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.
framework
- Type:
object[] - Default:
[]
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. Each entry can also have 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.
| Key | Type | Default |
|---|---|---|
name | string | |
detection | object | |
enablers | string[] | [] |
entryPoints | string[] | [] |
entryPointRole | string | "support" |
manifestEntries | object[] | [] |
configPatterns | string[] | [] |
configDefaultExportOptOut | string[] | [] |
alwaysUsed | string[] | [] |
toolingDependencies | string[] | [] |
usedExports | object[] | [] |
usedClassMembers | (string or object)[] | [] |
framework[].name
- Type:
string
Unique name for this plugin.
framework[].detection
- Type:
object(optional)
Rich detection logic (dependency checks, file existence, boolean combinators). Takes priority over enablers when set.
framework[].detection.type
- Type:
string - Allowed values:
dependency
framework[].detection.package
- Type:
string
Exact package name looked up in the project's declared dependencies.
framework[].enablers
- Type:
string[] - Default:
[]
Package names that activate this plugin when found in package.json. Supports exact matches and prefix patterns (ending with /). Only used when detection is not set. A plugin with neither detection nor enablers never activates, and config load warns.
framework[].entryPoints
- Type:
string[] - Default:
[]
Glob patterns for entry point files.
framework[].entryPointRole
- Type:
string - Default:
"support"
Coverage role for entryPoints.
Defaults to support. Set to runtime for application entry points or test for test framework entry points. In production mode, a file that only entries with an explicit support role match takes no part in dead-code analysis.
Allowed values:
runtime: Runtime/application roots that should count toward runtime reachability.test: Test roots that should count toward test reachability.support: Support/setup/config roots that should keep files alive but not count as runtime/test.
framework[].manifestEntries
- Type:
object[] - Default:
[]
Entry points derived from framework manifest files.
Unlike entryPoints (static globs), each rule finds manifest files by a recursive glob, parses them, and seeds sibling entries resolved relative to each manifest's directory, gated on the manifest's own fields. Seeded entries use this plugin's entryPointRole.
framework[].manifestEntries[].manifests
- Type:
string
Recursive glob selecting the manifest files to read (e.g. **/kibana.jsonc). A single * stays within one path segment; use ** to match across directories.
framework[].manifestEntries[].format
- Type:
string - Default:
"jsonc"
Manifest format. Defaults to jsonc (which also parses plain JSON).
Allowed values:
jsonc: JSONC (comments + trailing commas). Also accepts plain JSON.json: Strict JSON.
framework[].manifestEntries[].when
- Type:
map of object or any
Manifest-level gate: a map of field path to an equality expectation or an explicit exists predicate. Paths use dotted object keys and may traverse arrays with [*]. ALL entries must match; a wildcard equality matches when any yielded value equals the expectation. An empty map matches every manifest.
| Key | Type | Default |
|---|---|---|
exists | boolean |
framework[].manifestEntries[].when.<key>.exists
- Type:
boolean
Whether the field path must resolve to at least one value.
framework[].manifestEntries[].entries
- Type:
object[]
Entry rules seeded per matching manifest.
framework[].manifestEntries[].entries[].path
- Type:
string
Entry glob relative to the manifest directory. May contain ${dotted.field} interpolation that fans out over string / array manifest field values; [*] traverses object arrays. A missing or empty field seeds nothing. The glob must encode its own extension, such as public/index.{ts,tsx}. Glob entry patterns are matched literally against discovered files without source-extension probing.
framework[].manifestEntries[].entries[].when
- Type:
map of object or any
Per-entry gate, using the same strict equality and [*] traversal as the manifest-level gate. An empty map always passes.
| Key | Type | Default |
|---|---|---|
exists | boolean |
framework[].manifestEntries[].entries[].when.<key>.exists
- Type:
boolean
Whether the field path must resolve to at least one value.
framework[].configPatterns
- Type:
string[] - Default:
[]
Glob patterns for config files (marked as always-used when active).
framework[].configDefaultExportOptOut
- Type:
string[] - Default:
[]
Entries of configPatterns whose files do not get the default export credit under includeEntryExports. Use it when the tool reads named exports, or when the pattern also matches ordinary source files. Write each entry exactly as in configPatterns. Other entries have no effect.
framework[].alwaysUsed
- Type:
string[] - Default:
[]
Files that are always considered "used" when this plugin is active.
framework[].toolingDependencies
- Type:
string[] - Default:
[]
Dependencies that are tooling (used via CLI/config, not source imports). These should not be flagged as unused devDependencies.
framework[].usedExports
- Type:
object[] - Default:
[]
Exports that are always considered used for matching file patterns.
framework[].usedExports[].pattern
- Type:
string
Glob pattern for files. A single * stays within one path segment; use ** to match across directories.
framework[].usedExports[].exports
- Type:
string[]
Export names always considered used.
framework[].usedClassMembers
- Type:
(string or object)[] - Default:
[]
Class member method/property rules the framework invokes at runtime. Supports plain member names for global suppression and scoped objects with extends / implements constraints when the method name is too common to suppress across the whole workspace.
| Key | Type | Default |
|---|---|---|
extends | string | |
implements | string | |
members | string[] |
framework[].usedClassMembers[].extends
- Type:
string(optional)
Only apply when the class extends this parent class name.
framework[].usedClassMembers[].implements
- Type:
string(optional)
Only apply when the class implements this interface name.
framework[].usedClassMembers[].members
- Type:
string[]
Member names or glob patterns that should be treated as framework-used.
plugins
- Type:
string[] - Default:
[]
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 warning, and paths listed here are searched before the auto-discovered locations (first occurrence of a plugin name wins).
rulePacks
- Type:
string[] - Default:
[]
Paths to declarative rule-pack files (JSON or JSONC), relative to the project root. Each pack declares banned-call, banned-import, or banned-effect rules that report as policy-violation findings. Packs are pure data: no project code is executed. Invalid or missing packs fail config load.