assura-diagnostics 0.4.3

Unified diagnostic types for the Assura compiler
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

use super::{Diagnostic, Severity};

/// Render a single `Diagnostic` to stderr using ariadne.
pub fn render_diagnostic(diag: &Diagnostic, filename: &str, source: &str) {
    use ariadne::{Color, Label, Report, ReportKind, Source};

    let kind = match diag.severity {
        Severity::Error => ReportKind::Error,
        Severity::Warning => ReportKind::Warning,
        Severity::Info => ReportKind::Advice,
    };
    let color = match diag.severity {
        Severity::Error => Color::Red,
        Severity::Warning => Color::Yellow,
        Severity::Info => Color::Blue,
    };
    let mut builder = Report::build(kind, (filename, diag.primary.clone()))
        .with_message(format!("[{}] {}", diag.code, diag.message))
        .with_label(
            Label::new((filename, diag.primary.clone()))
                .with_message(&diag.message)
                .with_color(color),
        );
    for sec in &diag.secondary {
        builder = builder.with_label(
            Label::new((filename, sec.span.clone()))
                .with_message(&sec.message)
                .with_color(Color::Blue),
        );
    }
    // Render suggestion as a help note when present.
    // Advice-only suggestions may have an empty replacement (no text edit);
    // avoid rendering empty backticks like "Help: message: ``".
    if let Some(ref suggestion) = diag.suggestion {
        let help = if suggestion.replacement.is_empty() {
            suggestion.message.clone()
        } else {
            format!("{}: `{}`", suggestion.message, suggestion.replacement)
        };
        builder = builder.with_help(help);
    }
    // Add an explain hint for errors so users know how to get more detail.
    if diag.severity == Severity::Error {
        builder = builder.with_note(format!(
            "for more information, run `assura explain {}`",
            diag.code
        ));
    }
    builder
        .finish()
        .eprint((filename, Source::from(source)))
        .ok();
}

/// Render a list of diagnostics to stderr using ariadne.
pub fn report_diagnostics_human(diagnostics: &[Diagnostic], filename: &str, source: &str) {
    for d in diagnostics {
        render_diagnostic(d, filename, source);
    }
}