Module explain 

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_RULES

Rule definitions for every dead-code family finding.

DUPES_RULES

Rule definitions for duplication findings.

FLAGS_RULES

Rule definitions for feature-flag findings.

HEALTH_RULES

Rule definitions for complexity and health findings.

SECURITY_RULES

Rule definitions for security candidate findings, including the data-driven tainted-sink catalogue categories.

Functions

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.

explain_issue_type

Build the typed standalone explain output for a user-facing issue token.

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.

security_meta

Build the _meta object for fallow security --format json --explain.

serialize_explain_programmatic_json

Serialize standalone explain output using the programmatic API contract.

unknown_explain_error

Structured error for an unrecognized fallow explain issue type, with suggestions matched to whether the token looks security-related.