diagprint 0.8.1

A Rust diagnostics lifecycle framework for structured diagnostics, rendering, remediation, CI, editors, and telemetry.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

mod audit_transcript;
mod compiler_text;
mod github_actions;
mod github_actions_delta;

#[cfg(feature = "html")]
mod html;

mod json;
mod markdown;
mod plain;
mod rendered_artifact;
mod sarif;
mod source_context;
mod terminal;
mod theme;

pub use audit_transcript::AuditTranscriptRenderer;
pub use compiler_text::CompilerTextRenderer;
pub use github_actions::GithubActionsRenderer;
pub use github_actions_delta::GithubActionsDeltaRenderer;

#[cfg(feature = "html")]
pub use html::{HtmlRenderer, HtmlSourceOptions, HtmlTheme};

pub use json::JsonRenderer;
pub use markdown::{MarkdownRenderer, MarkdownSourceOptions};
pub use plain::PlainRenderer;

pub use rendered_artifact::{
    RENDERED_RECEIPT_V1_SCHEMA, RenderedArtifact, RenderedArtifactReceipt, RenderedFormat,
    RenderedSourceDescriptor, RenderedSourceMode,
};

pub use sarif::SarifRenderer;
pub use terminal::TerminalRenderer;
pub use theme::{SeverityTheme, Style, Theme};

use crate::Diagnostic;

pub trait Renderer {
    fn render(&self, diagnostic: &Diagnostic) -> String;
}

pub trait ReportRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String;
}

fn render_joined<'a>(
    renderer: &impl Renderer,
    diagnostics: impl IntoIterator<Item = &'a Diagnostic>,
    separator: &str,
) -> String {
    diagnostics
        .into_iter()
        .map(|diagnostic| renderer.render(diagnostic))
        .collect::<Vec<_>>()
        .join(separator)
}

impl ReportRenderer for PlainRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        render_joined(self, diagnostics, "\n")
    }
}

impl ReportRenderer for CompilerTextRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        render_joined(self, diagnostics, "\n")
    }
}

impl ReportRenderer for GithubActionsRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        render_joined(self, diagnostics, "\n")
    }
}

impl ReportRenderer for MarkdownRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        render_joined(self, diagnostics, "\n\n---\n\n")
    }
}

#[cfg(feature = "html")]
impl ReportRenderer for HtmlRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        HtmlRenderer::render_report(self, diagnostics)
    }
}

impl ReportRenderer for JsonRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        self.render_report_with_policy(diagnostics, &crate::ExportPolicy::default())
    }
}

impl ReportRenderer for SarifRenderer {
    fn render_report<'a>(&self, diagnostics: impl IntoIterator<Item = &'a Diagnostic>) -> String {
        self.render_many(diagnostics)
    }
}