Module explain 

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.

RuleGuide

Extra educational content for the standalone fallow explain <issue-type> command. Kept separate from RuleDef so SARIF and _meta payloads remain compact while terminal users and agents can ask for worked examples on demand.

Constants

CHECK_DOCS

Docs URL for the dead-code (check) command.

CHECK_RULES

COVERAGE_ANALYZE_DOCS

Docs URL for fallow coverage analyze --format json --explain.

COVERAGE_SETUP_DOCS

Docs URL for the runtime coverage setup command’s agent-readable JSON.

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 dead-code --format json --explain.

coverage_analyze_meta

Build the _meta object for fallow coverage analyze --format json --explain.

coverage_setup_meta

Build the _meta object for fallow coverage setup --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_by_token

Look up an issue type from a user-facing token.

rule_docs_url

Build the docs URL for a rule.

rule_guide

Return worked-example and fix guidance for a rule.

run_explain

Run the standalone explain subcommand.