Skip to main content

Module format

Module format 

Source

Functionsยง

apply_fixes
Apply fixes from violations to source files. Returns the number of fixes applied. Fixes are targeted to the specific line where the violation occurred to avoid accidentally replacing a different occurrence of the same pattern.
print_compact
Print violations in compact one-line-per-violation format. Violations go to stdout; summary goes to stderr.
print_github
Print violations as GitHub Actions workflow commands. Violations go to stdout; summary goes to stderr.
print_json
Print violations as structured JSON.
print_markdown
Print violations as a Markdown report (for GitHub PR summaries).
print_pretty
Print violations grouped by file with ANSI colors.
print_sarif
Print violations in SARIF v2.1.0 format for GitHub Code Scanning.