Repository navigation
docs: correct facts that differ from fallow main - #347
Merged
Merged
Conversation
…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>
1 of 8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
--include-entry-exports. Three pages state this rule.crates/core/src/analyze/unused_exports.rsprivate. Fallow does not collect private members.crates/extract/src/visitor/helpers.rstype-only-dependenciestest-only-dependenciesruns only outside production mode.crates/core/src/analyze/dependency_detectors.rscrates/core/src/discover/walk.rs--coveragereplaces thestatic_estimatedmodel.crates/output/src/health_coverage.rs16+,51+).crates/extract/src/complexity.rs--neardetects function-scoped Type-3 clones.fallow similar-codecovers the Type-4 case. The output samples match the human report.crates/cli/src/report/human/dupes.rsunlisted-binariesandduplicate-export-aliasesdefault towarn.unused-protected-class-membersdefaults tooff.crates/config/src/config/rules.rsschema_versioncrates/output/src/check.rs./coverage.crates/cli/src/coverage/mod.rsAdded reference rows
fallow audit --stagedfallow coverage upload-static-findings, and--vercel-deployment-idon the upload commands--groupflag, and the--type-couplingand--mutation-reportrows offallow healthsharedStateAllowlistconfig keyFALLOW_CREDENTIAL_STOREenvironment variableconfiguration/environment.mdxhad the section "One cache directory for several projects" twice, word for word. One copy is removed.Test plan
npm run checkpasses (manifest, tests, anchors, plugin list)node scripts/check-comment-quality.mjs --allpassesmainCloses: N/A