pedant 0.12.0

An opinionated Rust linter, with special focus on AI-generated code
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

use std::io::{self, Write};

use pedant_core::GateVerdict;
use pedant_core::json_format::JsonViolation;
use pedant_core::violation::Violation;

/// Output format for violation reports.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, clap::ValueEnum)]
pub enum OutputFormat {
    /// Human-readable text, one violation per line.
    #[default]
    Text,
    /// JSON array of violation objects.
    Json,
}

/// Formats and writes violation reports to a writer.
pub struct Reporter {
    format: OutputFormat,
    quiet: bool,
}

impl Reporter {
    /// Creates a reporter with the given format and quiet mode.
    pub fn new(format: OutputFormat, quiet: bool) -> Self {
        Self { format, quiet }
    }

    /// Writes all violations to the given writer in the configured format.
    pub fn report<W: Write>(&self, violations: &[Violation], writer: &mut W) -> io::Result<()> {
        match self.format {
            OutputFormat::Text => self.report_text(violations, writer),
            OutputFormat::Json => self.report_json(violations, writer),
        }
    }

    fn report_text<W: Write>(&self, violations: &[Violation], writer: &mut W) -> io::Result<()> {
        for v in violations {
            writeln!(writer, "{v}")?;
        }

        if !self.quiet && !violations.is_empty() {
            writeln!(writer)?;
            writeln!(writer, "Found {} violation(s)", violations.len())?;
        }

        Ok(())
    }

    fn report_json<W: Write>(&self, violations: &[Violation], writer: &mut W) -> io::Result<()> {
        let json_violations: Vec<JsonViolation<'_>> =
            violations.iter().map(JsonViolation::from).collect();
        serde_json::to_writer_pretty(&mut *writer, &json_violations).map_err(io::Error::other)?;
        writeln!(writer)?;
        Ok(())
    }

    /// Writes gate verdicts to the given writer in the configured format.
    pub fn report_gate<W: Write>(
        &self,
        verdicts: &[GateVerdict],
        writer: &mut W,
    ) -> io::Result<()> {
        match self.format {
            OutputFormat::Text => self.report_gate_text(verdicts, writer),
            OutputFormat::Json => self.report_gate_json(verdicts, writer),
        }
    }

    fn report_gate_text<W: Write>(
        &self,
        verdicts: &[GateVerdict],
        writer: &mut W,
    ) -> io::Result<()> {
        for v in verdicts {
            writeln!(writer, "{}: {} — {}", v.severity, v.rule, v.rationale)?;
        }
        Ok(())
    }

    fn report_gate_json<W: Write>(
        &self,
        verdicts: &[GateVerdict],
        writer: &mut W,
    ) -> io::Result<()> {
        serde_json::to_writer_pretty(&mut *writer, verdicts).map_err(io::Error::other)?;
        writeln!(writer)?;
        Ok(())
    }
}