alint-output 0.3.2

Internal: output formatters for alint reports (human, json, ...). Not a stable public API.
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

use std::io::Write;

use alint_core::{FixReport, FixStatus, Level, Report};

pub fn write_human(report: &Report, w: &mut dyn Write) -> std::io::Result<()> {
    let mut any = false;
    for result in &report.results {
        if result.passed() {
            continue;
        }
        any = true;
        let sigil = level_sigil(result.level);
        writeln!(w, "{sigil}[{}]:", result.rule_id)?;
        for v in &result.violations {
            if let Some(path) = &v.path {
                writeln!(w, "  - {} — {}", path.display(), v.message)?;
            } else {
                writeln!(w, "  - {}", v.message)?;
            }
        }
        if let Some(url) = &result.policy_url {
            writeln!(w, "  policy: {url}")?;
        }
    }

    let failing = report.failing_rules();
    let passing = report.passing_rules();
    let total = report.total_violations();
    if any {
        writeln!(
            w,
            "\n{failing} rule(s) failing, {passing} passing, {total} violation(s)."
        )?;
    } else {
        writeln!(w, "All {passing} rule(s) passed.")?;
    }
    Ok(())
}

pub fn write_fix_human(report: &FixReport, w: &mut dyn Write) -> std::io::Result<()> {
    for rule in &report.results {
        let sigil = level_sigil(rule.level);
        writeln!(w, "{sigil}[{}]:", rule.rule_id)?;
        for item in &rule.items {
            let path = item
                .violation
                .path
                .as_ref()
                .map(|p| format!("{} — ", p.display()))
                .unwrap_or_default();
            match &item.status {
                FixStatus::Applied(summary) => {
                    writeln!(w, "  ✓ {path}{summary}")?;
                }
                FixStatus::Skipped(reason) => {
                    writeln!(
                        w,
                        "  · {path}{} (skipped: {reason})",
                        item.violation.message
                    )?;
                }
                FixStatus::Unfixable => {
                    writeln!(w, "  · {path}{} (no fixer)", item.violation.message)?;
                }
            }
        }
    }

    let applied = report.applied();
    let skipped = report.skipped();
    let unfixable = report.unfixable();
    writeln!(
        w,
        "\n{applied} applied, {skipped} skipped, {unfixable} unfixable."
    )?;
    Ok(())
}

fn level_sigil(level: Level) -> &'static str {
    match level {
        Level::Error => "error",
        Level::Warning => "warning",
        Level::Info => "info",
        Level::Off => "off",
    }
}