Skip to main content

Crate zuit_report

Crate zuit_report 

Source
Expand description

Output formatters for zuit analysis reports.

This crate provides six output formats for a zuit_core::engine::Report:

FormatFunctionNotes
JSONjson::render_jsonPretty-printed, stable field order. Documented in docs/json-schema.md.
Terminalterminal::render_terminalGrouped by dimension → severity. Optional ANSI colour and OSC-8 hyperlinks.
Markdownmarkdown::render_markdownScoreboard table + collapsible <details> blocks, PR-comment friendly.
SARIFsarif::render_sarifValid SARIF 2.1.0; single merged run strategy for v1.
Checkstylecheckstyle::render_checkstyleCheckstyle v8 XML; consumed by IntelliJ and SonarQube.
JUnitjunit::render_junitJUnit XML (Surefire/Maven flavour); consumed by GitHub Actions, Jenkins, and GitLab CI.

The top-level entry point is render, which dispatches to the appropriate sub-module based on a ReportFormat value.

Re-exports§

pub use checkstyle::render_checkstyle;
pub use json::render_json;
pub use junit::render_junit;
pub use markdown::render_markdown;
pub use sarif::render_sarif;
pub use terminal::render_terminal;

Modules§

checkstyle
Checkstyle XML formatter for zuit reports.
json
JSON formatter for zuit reports.
junit
JUnit XML formatter for zuit reports.
markdown
Markdown formatter for zuit reports.
sarif
SARIF 2.1.0 formatter for zuit reports.
terminal
Terminal formatter for zuit reports.

Structs§

RenderOptions
Options that control how a report is rendered.

Enums§

ReportError
Errors that can occur while rendering a report.
ReportFormat
The output format to render a Report into.

Functions§

render
Renders report in the requested format.