cargo-crap4rust 0.7.0

Cargo subcommand for computing CRAP scores across Rust crates
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

// Copyright 2025 Umberto Gotti <umberto.gotti@umbertogotti.dev>
// Licensed under the MIT License
// SPDX-License-Identifier: MIT

use crate::config::Config;
use crate::output_format::OutputFormat;
use crate::project_report::ProjectReport;
use crate::traits::reporter::Reporter;
use crate::verdict::Verdict;

#[derive(Debug, Clone, Copy, Default)]
pub struct StdoutReporter;

impl StdoutReporter {
    #[must_use]
    pub const fn new() -> Self {
        Self
    }

    fn print_human_report(&self, report: &ProjectReport, config: &Config) {
        println!("crap4rust report for {}", report.scope_name);
        println!();

        let visible_functions = report
            .functions
            .iter()
            .filter(|function| function.verdict != Verdict::Clean)
            .collect::<Vec<_>>();

        if visible_functions.is_empty() {
            println!(
                "No functions at or above the threshold of {:.1}.",
                config.threshold
            );
        } else {
            let package_width = visible_functions
                .iter()
                .map(|function| function.package_name.len())
                .max()
                .unwrap_or(7)
                .max("package".len());
            let name_width = visible_functions
                .iter()
                .map(|function| function.name.len())
                .max()
                .unwrap_or(4)
                .max("name".len());
            let file_width = visible_functions
                .iter()
                .map(|function| function.relative_file.len())
                .max()
                .unwrap_or(4)
                .max("file".len());

            println!(
                "{:<package_width$}  {:<name_width$}  {:<file_width$}  {:>4}  {:>10}  {:>10}  {:>10}  {:<7}",
                "package", "name", "file", "line", "complexity", "coverage", "crap", "verdict",
            );
            println!(
                "{}  {}  {}  {}  {}  {}  {}  {}",
                "-".repeat(package_width),
                "-".repeat(name_width),
                "-".repeat(file_width),
                "-".repeat(4),
                "-".repeat(10),
                "-".repeat(10),
                "-".repeat(10),
                "-".repeat(7),
            );

            for function in visible_functions {
                println!(
                    "{:<package_width$}  {:<name_width$}  {:<file_width$}  {:>4}  {:>10}  {:>9.1}%  {:>10.1}  {:<7}",
                    function.package_name,
                    function.name,
                    function.relative_file,
                    function.line,
                    function.complexity,
                    function.coverage * 100.0,
                    function.crap_score,
                    function.verdict.as_str(),
                );
            }
        }

        println!();
        println!(
            "summary: total_functions={} crappy_functions={} crappy_percent={:.1}% threshold={:.1} project_threshold={:.1}% verdict={}",
            report.total_functions,
            report.crappy_functions,
            report.crappy_percent,
            config.threshold,
            config.project_threshold,
            report.verdict.as_str(),
        );
    }

    fn print_json_report(&self, report: &ProjectReport) {
        let json = serde_json::to_string_pretty(report)
            .expect("serialization of report to JSON should never fail");
        println!("{json}");
    }
}

impl Reporter for StdoutReporter {
    fn render(&self, report: &ProjectReport, config: &Config) {
        match config.output_format {
            OutputFormat::Json => self.print_json_report(report),
            OutputFormat::Human => self.print_human_report(report, config),
        }
    }
}