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
fullDescriptionand 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
_metaobject forfallow check --format json --explain. - dupes_
meta - Build the
_metaobject forfallow dupes --format json --explain. - health_
meta - Build the
_metaobject forfallow 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.