Skip to main content

Module explain

Module explain 

Source
Expand description

Metric and rule definitions for explainable CLI output. Metric and rule definitions for explainable CLI output.

Provides structured metadata that describes what each metric, threshold, and rule means — consumed by the _meta object in JSON output and by SARIF fullDescription / helpUri fields.

Structs§

RuleDef
Rule definition for SARIF fullDescription and JSON _meta.

Constants§

CHECK_DOCS
Docs URL for the check command.
CHECK_RULES
DUPES_DOCS
Docs URL for the dupes command.
DUPES_RULES
HEALTH_DOCS
Docs URL for the health command.
HEALTH_RULES

Functions§

check_meta
Build the _meta object for fallow check --format json --explain.
dupes_meta
Build the _meta object for fallow dupes --format json --explain.
health_meta
Build the _meta object for fallow health --format json --explain.
rule_by_id
Look up a rule definition by its SARIF rule ID across all rule sets.
rule_docs_url
Build the docs URL for a rule.