deslop 0.2.0

A static analyzer that spots low-context and AI-assisted code patterns across naming, concurrency, security, performance, and test quality.
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

use crate::analysis::{ParsedFile, ParsedFunction};
use crate::model::{Finding, Severity};

pub(crate) const BINDING_LOCATION: &str = file!();

use super::common::{is_title_doc, is_tutorial_doc};

pub(super) fn comment_findings(file: &ParsedFile, function: &ParsedFunction) -> Vec<Finding> {
    let mut findings = Vec::new();
    let Some(doc_comment) = &function.doc_comment else {
        return findings;
    };

    let first_line = doc_comment
        .lines()
        .map(str::trim)
        .find(|line| !line.is_empty())
        .unwrap_or("");

    if is_title_doc(first_line) {
        findings.push(Finding {
            rule_id: "comment_style_title_case".to_string(),
            severity: Severity::Info,
            path: file.path.clone(),
            function_name: Some(function.fingerprint.name.clone()),
            start_line: function.fingerprint.start_line,
            end_line: function.fingerprint.start_line,
            message: format!(
                "function {} uses Title Case documentation that reads more like a heading",
                function.fingerprint.name
            ),
            evidence: vec![format!("doc comment line: {first_line}")],
        });
    }

    if is_tutorial_doc(doc_comment) {
        findings.push(Finding {
            rule_id: "comment_style_tutorial".to_string(),
            severity: Severity::Info,
            path: file.path.clone(),
            function_name: Some(function.fingerprint.name.clone()),
            start_line: function.fingerprint.start_line,
            end_line: function.fingerprint.start_line,
            message: format!(
                "function {} has a verbose tutorial-style doc comment",
                function.fingerprint.name
            ),
            evidence: vec![format!(
                "doc comment spans {} lines",
                doc_comment.lines().count()
            )],
        });
    }

    findings
}