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
62
63
64
65
66

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

// cha:ignore todo_comment
/// Detect leftover task comments (todo/fixme/hack/xxx) in source code.
///
/// Severity levels: H/X tags → Warning, F/T tags → Hint.
pub struct TodoTrackerAnalyzer;

impl Plugin for TodoTrackerAnalyzer {
    fn name(&self) -> &str {
        "todo_tracker"
    }

    fn description(&self) -> &str {
        "Leftover TODO/FIXME/HACK/XXX comments"
    }

    fn analyze(&self, ctx: &AnalysisContext) -> Vec<Finding> {
        ctx.model
            .comments
            .iter()
            .filter_map(|c| check_comment(c, ctx))
            .collect()
    }
}

fn check_comment(c: &crate::CommentInfo, ctx: &AnalysisContext) -> Option<Finding> {
    let upper = c.text.to_uppercase();
    let (tag, severity) = if has_tag(&upper, "HACK") {
        ("HACK", Severity::Warning)
    } else if has_tag(&upper, "XXX") {
        ("XXX", Severity::Warning)
    } else if has_tag(&upper, "FIXME") {
        ("FIXME", Severity::Hint)
    } else if has_tag(&upper, "TODO") {
        ("TODO", Severity::Hint)
    } else {
        return None;
    };
    Some(Finding {
        smell_name: "todo_comment".into(),
        category: SmellCategory::Dispensables,
        severity,
        location: Location {
            path: ctx.file.path.clone(),
            start_line: c.line,
            end_line: c.line,
            name: None,
        },
        message: format!(
            "{tag}: {}",
            c.text.trim_start_matches(['/', '#', '*', ' ', '-'])
        ),
        suggested_refactorings: vec!["Resolve or create a tracking issue".into()],
    })
}

/// Match tag as a word boundary (e.g. "TAG:" or "TAG " but not "TAGLIST")
fn has_tag(line: &str, tag: &str) -> bool {
    if let Some(pos) = line.find(tag) {
        let after = pos + tag.len();
        after >= line.len() || !line.as_bytes()[after].is_ascii_alphabetic()
    } else {
        false
    }
}