diagprint 0.6.0

Pretty, structured diagnostics and reports for Rust applications.
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

use super::Renderer;
use crate::{Diagnostic, Label, LabelKind};

#[derive(Debug, Default, Clone, Copy)]
pub struct MarkdownRenderer;

fn label_kind_name(kind: LabelKind) -> &'static str {
    match kind {
        LabelKind::Primary => "Primary",
        LabelKind::Secondary => "Secondary",
    }
}

fn label_location(label: &Label) -> String {
    let location = &label.location;

    format!(
        "{}:{}{}",
        location.file,
        location.line,
        location
            .column
            .map(|column| format!(":{column}"))
            .unwrap_or_default()
    )
}

impl Renderer for MarkdownRenderer {
    fn render(&self, d: &Diagnostic) -> String {
        let mut o = format!(
            "# {}{}\n\n**Application:** `{}`  \n**Timestamp:** `{}`  \n**PID:** `{}`  \n**Host:** `{}`  \n**Session:** `{}`  \n**Report:** `{}`\n\n## Message\n\n{}\n",
            d.severity,
            d.code
                .as_ref()
                .map(|c| format!(" — `{c}`"))
                .unwrap_or_default(),
            d.application,
            d.timestamp.to_rfc3339(),
            d.pid,
            d.hostname,
            d.session_id,
            d.report_id,
            d.message
        );

        if !d.labels.is_empty() {
            o.push_str("\n## Labels\n\n");

            for label in &d.labels {
                o.push_str(&format!(
                    "- **{}:** `{}`",
                    label_kind_name(label.kind),
                    label_location(label)
                ));

                if let Some(length) = label.length {
                    o.push_str(&format!(" (length: `{length}`)"));
                }

                if let Some(message) = &label.message {
                    o.push_str(" — ");
                    o.push_str(message);
                }

                o.push('\n');
            }
        }

        if let Some(c) = &d.cause {
            o.push_str("\n## Causes\n\n");

            for (i, x) in c.iter().enumerate() {
                o.push_str(&format!("{}- {}\n", "  ".repeat(i), x.message));
            }
        }

        if !d.notes.is_empty() {
            o.push_str("\n## Notes\n\n");

            for n in &d.notes {
                o.push_str(&format!("- {n}\n"));
            }
        }

        if let Some(h) = &d.help {
            o.push_str(&format!("\n## Help\n\n{h}\n"));
        }

        o
    }
}