Skip to content

README.md

Latest commit

 

History

History
34 lines (27 loc) · 1.74 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.74 KB
Raw

cargo-fallow documentation

The README is the overview. The pages below are the reference for each command.

Commands

Page Contents
The check command Flags of check, and the health score
Adoption Changed files, packages, rule severity, baselines, init and suppressions
Unused dependencies Rules of deps, and the cases where it counts a dependency as used
Fix What cargo fallow fix changes, and how the command checks the result
Unused files How files finds the files that no target compiles
Visibility Kinds of visibility, and precise mode
Structure checks boundaries, size, complexity and dupes
API changes api --base <REF>
Trace --trace of visibility, deps and dupes, to see why a check reports one item or does not
Mutation testing mutants: tiers, status, test selection and safety
Output formats Each format, the JSON Schema, explain and the exit codes
Hooks The agent gate of Claude Code and Codex, and the git pre-commit hook
GitHub Action Inputs, outputs and install methods of the action
GitLab CI The template: code quality report and merge request note

Reference files

  • output-schema.json is the JSON Schema of each JSON document. cargo fallow schema prints the same schema.
  • health-score.md records the corpus data behind the weights of the health score.

Maintainers