cargo-crap4rust 0.4.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

// Copyright 2025 Umberto Gotti <umberto.gotti@umbertogotti.dev>
// Licensed under the MIT License or Apache License, Version 2.0
// SPDX-License-Identifier: MIT OR Apache-2.0

use std::path::PathBuf;

#[derive(Debug, Clone)]
pub struct Config {
    pub coverage_path: Option<PathBuf>,
    pub manifest_path: Option<PathBuf>,
    pub packages: Vec<String>,
    pub features: Option<String>,
    pub all_features: bool,
    pub no_default_features: bool,
    pub include_test_targets: bool,
    pub exclude_paths: Vec<String>,
    pub threshold: f64,
    pub warn_threshold: f64,
    pub project_threshold: f64,
    pub strict: bool,
    pub warn_only: bool,
}

#[derive(Debug, Clone)]
pub struct PackageContext {
    pub name: String,
    pub manifest_dir: PathBuf,
    pub workspace_root: PathBuf,
    pub source_roots: Vec<PathBuf>,
    pub include_test_targets: bool,
    pub exclude_paths: Vec<String>,
}

#[derive(Debug, Clone)]
pub struct SourceFunction {
    pub package_name: String,
    pub name: String,
    pub path_key: String,
    pub relative_file: String,
    pub line: usize,
    pub end_line: usize,
    pub complexity: u32,
}

#[derive(Debug, Clone)]
pub struct CoverageRecord {
    pub path_key: String,
    pub line: usize,
    pub covered_regions: u32,
    pub total_regions: u32,
}

impl CoverageRecord {
    pub fn coverage_ratio(&self) -> f64 {
        if self.total_regions == 0 {
            0.0
        } else {
            f64::from(self.covered_regions) / f64::from(self.total_regions)
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Verdict {
    Clean,
    Warn,
    Crappy,
}

impl Verdict {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Clean => "clean",
            Self::Warn => "warn",
            Self::Crappy => "crappy",
        }
    }
}

#[derive(Debug, Clone)]
pub struct FunctionReport {
    pub package_name: String,
    pub name: String,
    pub relative_file: String,
    pub line: usize,
    pub complexity: u32,
    pub coverage: f64,
    pub crap_score: f64,
    pub verdict: Verdict,
}

#[derive(Debug, Clone)]
pub struct ProjectReport {
    pub scope_name: String,
    pub total_functions: usize,
    pub crappy_functions: usize,
    pub crappy_percent: f64,
    pub verdict: Verdict,
    pub functions: Vec<FunctionReport>,
}