cha-core 0.6.5

Core analysis engine for Cha — pluggable code smell detection
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

use crate::{AnalysisContext, Finding, Location, Plugin, Severity, SmellCategory};

/// Detect functions where comment lines exceed a threshold ratio.
pub struct CommentsAnalyzer {
    pub max_comment_ratio: f64,
    pub min_lines: usize,
}

impl Default for CommentsAnalyzer {
    fn default() -> Self {
        Self {
            max_comment_ratio: 0.3,
            min_lines: 10,
        }
    }
}

impl Plugin for CommentsAnalyzer {
    fn name(&self) -> &str {
        "comments"
    }

    fn description(&self) -> &str {
        "Excessive comment-to-code ratio"
    }

    fn analyze(&self, ctx: &AnalysisContext) -> Vec<Finding> {
        ctx.model
            .functions
            .iter()
            .filter_map(|f| {
                if f.line_count < self.min_lines || f.comment_lines == 0 {
                    return None;
                }
                let ratio = f.comment_lines as f64 / f.line_count as f64;
                if ratio <= self.max_comment_ratio {
                    return None;
                }
                Some(Finding {
                    smell_name: "excessive_comments".into(),
                    category: SmellCategory::Dispensables,
                    severity: Severity::Hint,
                    location: Location {
                        path: ctx.file.path.clone(),
                        start_line: f.start_line,
                        end_line: f.end_line,
                        name: Some(f.name.clone()),
                    },
                    message: format!(
                        "Function `{}` has {:.0}% comment lines ({}/{}), consider Extract Method",
                        f.name,
                        ratio * 100.0,
                        f.comment_lines,
                        f.line_count
                    ),
                    suggested_refactorings: vec!["Extract Method".into(), "Rename Method".into()],
                })
            })
            .collect()
    }
}