Skip to content

docs: correct facts that differ from fallow main - #347

Merged
BartWaardenburg merged 5 commits into
mainfrom
fix/fact-corrections
Nov 19, 2026
Merged

BartWaardenburg merged 5 commits into
mainfrom
fix/fact-corrections

Conversation

@BartWaardenburg

Copy link
Copy Markdown
Contributor

Summary

These pages stated facts that differ from fallow main, or left out flags and keys that exist. Each correction was checked against the source file named below. No page moves and no section changes place.

Corrected facts

Area Correction Source
Entry-file exports By default, fallow assumes that external code uses the exports of an entry file. It checks them when a plugin declares the used exports of that file, or with --include-entry-exports. Three pages state this rule. crates/core/src/analyze/unused_exports.rs
Class members The two "Unused" example methods are no longer private. Fallow does not collect private members. crates/extract/src/visitor/helpers.rs
type-only-dependencies The rule runs only in production mode. test-only-dependencies runs only outside production mode. crates/core/src/analyze/dependency_detectors.rs
Production mode The table of excluded files matches the exclude patterns. crates/core/src/discover/walk.rs
CRAP model --coverage replaces the static_estimated model. crates/output/src/health_coverage.rs
Complexity example The cognitive score is 7. The ranges do not overlap (16+, 51+). crates/extract/src/complexity.rs
Clone types --near detects function-scoped Type-3 clones. fallow similar-code covers the Type-4 case. The output samples match the human report. crates/cli/src/report/human/dupes.rs
Rule defaults unlisted-binaries and duplicate-export-aliases default to warn. unused-protected-class-members defaults to off. crates/config/src/config/rules.rs
schema_version Three dead-code examples show 11. crates/output/src/check.rs
Runtime input path The example uses ./coverage. crates/cli/src/coverage/mod.rs

Added reference rows

  • fallow audit --staged
  • fallow coverage upload-static-findings, and --vercel-deployment-id on the upload commands
  • the global --group flag, and the --type-coupling and --mutation-report rows of fallow health
  • the sharedStateAllowlist config key
  • the FALLOW_CREDENTIAL_STORE environment variable

configuration/environment.mdx had the section "One cache directory for several projects" twice, word for word. One copy is removed.

Test plan

  • npm run check passes (manifest, tests, anchors, plugin list)
  • node scripts/check-comment-quality.mjs --all passes
  • Each corrected fact read in the source on fallow main

Closes: N/A

…facts

- Exports of an entry file count as used by default. Fallow checks
  them when a plugin declares the used exports of that file, or with
  --include-entry-exports.
- unused-class-members does not report private members. The examples
  with an unused method no longer mark that method private.
- Fallow checks type-only-dependencies only in production mode.
- The dead-code JSON examples use schema_version 11.
- The production-mode exclude list is complete: it adds the e2e-spec,
  bench, fixture, story, snapshot and test-d patterns, root config
  files and hidden script files.
- The severity tables use one label, Warning.

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
- The nested if example has a cognitive complexity of 7, not 9.
- The cyclomatic notes count the base path of 1.
- The cognitive ranges do not overlap. A finding starts above 15, so
  the last range starts at 16. The last cyclomatic range starts at 51.
- Without coverage data, CRAP uses the static_estimated model.
- The health options tables list --type-coupling and --mutation-report.

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
- fallow dupes detects function-scoped Type-3 clones with --near.
- For Type-4 clones, the page points to fallow similar-code.
- The clone group and clone family samples show the real human output.
- The explanations index describes what the duplication page covers.

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
- fallow audit --staged audits the staged changes against HEAD.
- fallow coverage upload-static-findings uploads the dead-code
  findings for the source view.
- upload-inventory and upload-source-maps accept
  --vercel-deployment-id.
- The global flags list --group, which only fallow health supports.
- --include-entry-exports states the plugin exception.
- The runtime coverage example uses ./coverage, the path that setup
  writes.

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
- The default warn list names unlisted-binaries and
  duplicate-export-aliases. The default off list names
  unused-protected-class-members.
- type-only-dependencies runs only in production mode, and
  test-only-dependencies only outside it.
- The config reference lists sharedStateAllowlist.
- The environment reference lists FALLOW_CREDENTIAL_STORE.
- The FALLOW_CACHE_MAX_SIZE section no longer repeats the cache
  directory section of FALLOW_CACHE_DIR.

Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
@BartWaardenburg
BartWaardenburg merged commit db4c295 into main Nov 19, 2026
4 checks passed
@BartWaardenburg
BartWaardenburg deleted the fix/fact-corrections branch November 19, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant