torrust-linting 0.1.0

Linting utilities for Torrust projects
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

use std::process::Command;
use std::time::Instant;

use anyhow::Result;
use tracing::{error, info};

/// Run the Rust clippy linter
///
/// # Errors
///
/// Returns an error if cargo clippy is not available or if the linting fails.
pub fn run_clippy_linter() -> Result<()> {
    let t = Instant::now();
    info!(target: "clippy", "Running Rust Clippy linter...");

    let mut cmd = Command::new("cargo");
    cmd.env("CARGO_INCREMENTAL", "0").args([
        "clippy",
        "--quiet",
        "--no-deps",
        "--tests",
        "--benches",
        "--examples",
        "--workspace",
        "--all-targets",
        "--all-features",
        "--",
        "-D",
        "clippy::correctness",
        "-D",
        "clippy::suspicious",
        "-D",
        "clippy::complexity",
        "-D",
        "clippy::perf",
        "-D",
        "clippy::style",
        "-D",
        "clippy::pedantic",
    ]);

    let output = cmd.output()?;

    if output.status.success() {
        info!(target: "clippy", "Clippy linting completed successfully! ({:.3}s)", t.elapsed().as_secs_f64());
        Ok(())
    } else {
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);

        // Print the output from clippy
        if !stdout.is_empty() {
            println!("{stdout}");
        }
        if !stderr.is_empty() {
            eprintln!("{stderr}");
        }

        println!();
        error!(target: "clippy", "Clippy linting failed. Please fix the issues above. ({:.3}s)", t.elapsed().as_secs_f64());
        Err(anyhow::anyhow!("Clippy linting failed"))
    }
}