Structs§
- Audit
Config - Per-analysis baseline paths for the
auditcommand. - Boundary
Config - Architecture boundary configuration.
- Boundary
Rule - An import rule between zones.
- Boundary
Zone - A named zone grouping files by directory pattern.
- Config
Override - Per-file override entry.
- Duplicates
Config - Configuration for code duplication detection.
- External
Plugin Def - A declarative plugin definition loaded from a standalone file or inline config.
- External
Used Export - Exports considered used for files matching a pattern.
- Fallow
Config - User-facing configuration loaded from
.fallowrc.jsonorfallow.toml. - Flags
Config - Feature flag detection configuration.
- Health
Config - Configuration for complexity health metrics (
fallow health). - Ignore
Export Rule - Rule for ignoring specific exports.
- Ignore
Exports Used InFile ByKind - Knip-compatible
ignoreExportsUsedInFileobject form. - Normalization
Config - Fine-grained normalization overrides.
- Ownership
Config - Configuration for ownership analysis (
fallow health --hotspots --ownership). - Package
Json - Parsed package.json with fields relevant to fallow.
- Partial
Rules Config - Partial per-issue-type severity for overrides. All fields optional.
- PerAnalysis
Production Config - Per-analysis production-mode defaults.
- Regression
Baseline - Per-type issue counts for regression comparison.
- Regression
Config - Regression baseline counts, embedded in the config file.
- Resolve
Config - Module resolver configuration.
- Resolved
Boundary Config - Resolved boundary config with pre-compiled glob matchers.
- Resolved
Boundary Rule - A resolved boundary rule.
- Resolved
Config - Fully resolved configuration with all globs pre-compiled.
- Resolved
Normalization - Resolved normalization flags: mode defaults merged with user overrides.
- Resolved
Override - Resolved override with pre-compiled glob matchers.
- Resolved
Zone - A zone with pre-compiled glob matchers.
- Rules
Config - Per-issue-type severity configuration.
- Scoped
Used Class Member Rule - A heritage-constrained
usedClassMembersrule. - SdkPattern
- A custom SDK call pattern for feature flag detection.
- Workspace
Config - Workspace configuration for monorepo support.
- Workspace
Diagnostic - A diagnostic about workspace configuration issues.
- Workspace
Info - Discovered workspace info from package.json, pnpm-workspace.yaml, or tsconfig.json references.
Enums§
- Boundary
Preset - Built-in architecture presets.
- Detection
Mode - Detection mode controlling how aggressively tokens are normalized.
- Email
Mode - Privacy mode for author emails emitted in ownership output.
- Entry
Point Role - How a plugin’s discovered entry points contribute to coverage reachability.
- Ignore
Exports Used InFile Config - Controls whether exports referenced only inside their defining file are reported as unused exports.
- Output
Format - Output format for results.
- Plugin
Detection - How to detect if a plugin should be activated.
- Production
Analysis - Analysis-specific production-mode selector.
- Production
Config - Production-mode defaults.
- Severity
- Severity level for rules.
- Used
Class Member Rule - A
usedClassMembersentry from config or an external plugin.
Functions§
- discover_
external_ plugins - Discover and load external plugin definitions for a project.
- discover_
workspaces - Discover all workspace packages in a monorepo.
- find_
undeclared_ workspaces - Find directories containing
package.jsonthat are not declared as workspaces. - find_
undeclared_ workspaces_ with_ ignores - Find directories containing
package.jsonthat are not declared as workspaces, excluding candidates covered by the supplied ignore globset. - parse_
tsconfig_ root_ dir - Parse
tsconfig.jsonat the project root and extractcompilerOptions.rootDir.