godlint-cli 0.1.0

Command-line interface for Godlint.
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

use std::process::ExitCode;

use godlint_core::suppression::{Suppression, collect};

use crate::workspace::Workspace;

pub const USAGE: &str = "suppressions [paths...]";

pub fn run(arguments: &[String]) -> Option<ExitCode> {
    let [command, paths @ ..] = arguments else {
        return None;
    };

    if command != "suppressions" {
        return None;
    }

    Some(match list(paths) {
        Ok(exit_code) => exit_code,
        Err(message) => {
            eprintln!("{message}");
            ExitCode::from(2)
        }
    })
}

fn list(paths: &[String]) -> Result<ExitCode, String> {
    let workspace = Workspace::prepare(paths)?;
    let report = workspace.scan()?;
    let suppressions = collect(&report.facts);

    if suppressions.is_empty() {
        println!("No suppressions.");

        return Ok(ExitCode::SUCCESS);
    }

    for suppression in &suppressions {
        println!("{}", describe(suppression));
    }

    println!("\n{} suppressions.", suppressions.len());

    Ok(ExitCode::SUCCESS)
}

fn describe(suppression: &Suppression) -> String {
    let mut fields = vec![
        format!(
            "{}:{}",
            suppression.source().path().display(),
            suppression.line()
        ),
        suppression.scope().directive().to_owned(),
        suppression.rules().join(","),
    ];

    if let Some(owner) = suppression.owner() {
        fields.push(format!("owner={owner}"));
    }

    if let Some(expires) = suppression.expires() {
        fields.push(format!("expires={expires}"));
    }

    fields.push(format!(
        "-- {}",
        suppression.justification().unwrap_or("(no justification)")
    ));

    fields.join(" ")
}