MetaCredo. CLI. Output
(MetaCredo v0.3.3)
View Source
Terminal output formatting for MetaCredo analysis results.
Summary
Functions
Prints explanation for a check module.
Prints issues in GitHub Actions workflow command format.
Prints the full analysis report to stdout.
Formats issues as JSON string.
Functions
@spec print_explanation(module(), MetaCredo.Issue.t() | nil, atom() | nil) :: :ok
Prints explanation for a check module.
When issue is provided (typically from a file:lineno invocation), the
relevant code snippet is shown first, ±3 lines around the flagged line.
language controls which language-keyed examples entry is rendered.
When nil, the examples section is omitted entirely.
@spec print_github(map()) :: :ok
Prints issues in GitHub Actions workflow command format.
Produces ::error / ::warning lines that GitHub Actions renders as
inline PR annotations.
@spec print_report(map()) :: :ok
Prints the full analysis report to stdout.
Formats issues as JSON string.