Expand description
Output formatters for zuit analysis reports.
This crate provides six output formats for a zuit_core::engine::Report:
| Format | Function | Notes |
|---|---|---|
| JSON | json::render_json | Pretty-printed, stable field order. Documented in docs/json-schema.md. |
| Terminal | terminal::render_terminal | Grouped by dimension → severity. Optional ANSI colour and OSC-8 hyperlinks. |
| Markdown | markdown::render_markdown | Scoreboard table + collapsible <details> blocks, PR-comment friendly. |
| SARIF | sarif::render_sarif | Valid SARIF 2.1.0; single merged run strategy for v1. |
| Checkstyle | checkstyle::render_checkstyle | Checkstyle v8 XML; consumed by IntelliJ and SonarQube. |
JUnit | junit::render_junit | JUnit 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
JUnitXML 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§
- Render
Options - Options that control how a report is rendered.
Enums§
- Report
Error - Errors that can occur while rendering a report.
- Report
Format - The output format to render a
Reportinto.
Functions§
- render
- Renders
reportin the requested format.