Skip to main content

Module explain

Module explain 

Source
Expand description

CLI rendering for explainable rule output.

The rule registry and JSON contract live in fallow-api so embedders and MCP do not depend on the CLI crate. This module keeps terminal rendering and compatibility re-exports for existing CLI call sites.

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
DUPES_RULES
FLAGS_RULES
HEALTH_RULES
SECURITY_RULES

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.
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.
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.