Skip to main content

Module check

Module check 

Source
Expand description

Checks over the corpus: rules, their scope, and the findings they report.

Re-exports§

pub use context::Options;
pub use finding::Finding;
pub use finding::Fix;
pub use finding::Severity;
pub use runner::Report;
pub use runner::Selection;
pub use runner::run;
pub use scope::Range;

Modules§

baseline
A committed baseline of known findings, so a project can adopt specfold on an existing pile: what is already there is accepted, anything new fails, and the counts may only go down. Used by spec check ([check] baseline) and by each guard (its baseline); strict paths never get one.
context
Everything a rule needs: the corpus, its graph, the scope of the run and the options.
finding
What a check reports: one problem, where it is, and how to fix it.
rule
The rule interface. Each rule carries its own explanation, which is the rule’s documentation.
rules
The rule catalog, one module per family.
runner
Runs the selected rules and orders their findings.
scope
Which documents a run looks at: all of them, or the ones touched by a change and the documents that point at them.
severity
[check] severity: a project turns a rule down to a warning, up to an error, or off.