Skip to main content

Module report

Module report 

Source
Expand description

Report formatting utilities for analysis results.

Exposed for snapshot testing of output formats.

Structs§

ReportContext
Shared context for all report dispatch functions.

Enums§

Level
Severity level for human-readable output.

Functions§

build_codeclimate
Build CodeClimate JSON array from dead-code analysis results.
build_compact_lines
Build compact output lines for analysis results. Each issue is represented as a single prefix:details line.
build_duplication_codeclimate
Build CodeClimate JSON array from duplication analysis results.
build_duplication_markdown
Build markdown output for duplication results.
build_health_codeclimate
Build CodeClimate JSON array from health/complexity analysis results.
build_health_markdown
Build markdown output for health (complexity) results.
build_health_sarif
build_json
Build the JSON output value for analysis results.
build_markdown
Build markdown output for analysis results.
build_sarif
elide_common_prefix
Elide the common directory prefix between a base path and a target path. Only strips complete directory segments (never partial filenames). Returns the remaining suffix of target.
emit_json
Serialize a JSON value to pretty-printed stdout, returning the appropriate exit code.
normalize_uri
Normalize a path string to a valid URI: forward slashes and percent-encoded brackets.
plural
Return "s" for plural or "" for singular.
print_clone_trace
Print clone trace results.
print_cross_reference_findings
Print cross-reference findings (duplicated code that is also dead code).
print_dependency_trace
Print dependency trace results.
print_duplication_report
Print duplication analysis results in the configured format.
print_export_trace
Print export trace results.
print_file_trace
Print file trace results.
print_health_report
Print health (complexity) analysis results in the configured format.
print_performance
Print pipeline performance timings. In JSON mode, outputs to stderr to avoid polluting the JSON analysis output on stdout.
print_results
Print analysis results in the configured format. Returns exit code 2 if serialization fails, SUCCESS otherwise.
relative_path
Strip the project root prefix from a path for display, falling back to the full path.
severity_to_level
split_dir_filename
Split a path string into (directory, filename) for display. Directory includes the trailing /. If no directory, returns ("", filename).