cargo-shear 1.13.4

Detect and fix unused/misplaced dependencies from Cargo.toml
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

use std::io;

use miette::{Diagnostic, Severity, SourceCode};

use crate::diagnostics::{ShearAnalysis, ShearDiagnostic};

/// GitHub Actions workflow commands renderer.
///
/// Outputs diagnostics in the format:
/// `::error file={file},line={line},title={code}::{message}`
///
/// See <https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands>
pub struct GitHubRenderer<W> {
    writer: W,
}

impl<W: io::Write> GitHubRenderer<W> {
    pub const fn new(writer: W) -> Self {
        Self { writer }
    }

    pub fn render(&mut self, analysis: &ShearAnalysis) -> io::Result<()> {
        for diagnostic in &analysis.findings {
            self.render_diagnostic(diagnostic)?;
        }
        Ok(())
    }

    fn render_diagnostic(&mut self, diagnostic: &ShearDiagnostic) -> io::Result<()> {
        let level = match diagnostic.kind.severity() {
            Severity::Error => "error",
            Severity::Warning => "warning",
            Severity::Advice => "notice",
        };

        let code = diagnostic.kind.code();
        let message = diagnostic.kind.message();

        write!(self.writer, "::{level} ")?;

        let mut needs_comma = false;
        if let Some(source) = &diagnostic.source {
            write!(self.writer, "file={}", source.name())?;
            needs_comma = true;

            if let Some(span) = diagnostic.span
                && let Ok(contents) = source.read_span(&span, 0, 0)
            {
                let line = contents.line() + 1;
                let col = contents.column() + 1;
                write!(self.writer, ",line={line},col={col}")?;
            }
        }

        if needs_comma {
            write!(self.writer, ",")?;
        }
        write!(self.writer, "title={code}::{message}")?;

        if let Some(help) = diagnostic.help() {
            write!(self.writer, " ({help})")?;
        }

        writeln!(self.writer)?;
        Ok(())
    }
}