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
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

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

use super::{
    builder_internal, function_finding, is_borrowed_pathbuf_type, is_borrowed_string_type,
    is_borrowed_vec_type, is_library_like, is_public_api, normalized_type, parameter_entries,
    parameter_name_and_type, return_type_text, return_type_uses_anyhow_like_result,
    return_type_uses_box_dyn_error,
};

pub(super) fn api_surface_findings(file: &ParsedFile, function: &ParsedFunction) -> Vec<Finding> {
    if !is_public_api(function) {
        return Vec::new();
    }

    let mut findings = Vec::new();

    if is_library_like(file)
        && let Some(return_type) = return_type_text(&function.signature_text)
    {
        if return_type_uses_anyhow_like_result(file, &return_type) {
            findings.push(function_finding(
                file,
                function,
                "rust_public_anyhow_result",
                Severity::Warning,
                function.fingerprint.start_line,
                format!(
                    "public API {} returns an application-edge anyhow-style Result",
                    function.fingerprint.name
                ),
                vec![format!("return_type={return_type}")],
            ));
        }

        if return_type_uses_box_dyn_error(file, &return_type) {
            findings.push(function_finding(
                file,
                function,
                "rust_public_box_dyn_error",
                Severity::Warning,
                function.fingerprint.start_line,
                format!(
                    "public API {} exposes Box<dyn Error> instead of a clearer error surface",
                    function.fingerprint.name
                ),
                vec![format!("return_type={return_type}")],
            ));
        }
    }

    let parameters = parameter_entries(&function.signature_text);
    let bool_params = parameters
        .iter()
        .filter_map(|entry| parameter_name_and_type(entry))
        .filter(|(_, type_text)| normalized_type(type_text) == "bool")
        .collect::<Vec<_>>();

    if bool_params.len() == 1
        && !builder_internal(function)
        && !bool_param_is_explicit_mode_switch(function, &bool_params[0].0)
    {
        let (param_name, _) = &bool_params[0];
        findings.push(function_finding(
            file,
            function,
            "rust_public_bool_parameter_api",
            Severity::Info,
            function.fingerprint.start_line,
            format!(
                "public API {} exposes a raw boolean mode switch",
                function.fingerprint.name
            ),
            vec![format!("bool_parameter={param_name}")],
        ));
    }

    if !builder_internal(function) {
        for (param_name, type_text) in parameters
            .iter()
            .filter_map(|entry| parameter_name_and_type(entry))
        {
            if is_borrowed_string_type(&type_text) {
                findings.push(function_finding(
                    file,
                    function,
                    "rust_borrowed_string_api",
                    Severity::Info,
                    function.fingerprint.start_line,
                    format!(
                        "public API {} borrows String where &str would be more general",
                        function.fingerprint.name
                    ),
                    vec![
                        format!("parameter={param_name}"),
                        format!("type={type_text}"),
                    ],
                ));
            }

            if is_borrowed_vec_type(&type_text) {
                findings.push(function_finding(
                    file,
                    function,
                    "rust_borrowed_vec_api",
                    Severity::Info,
                    function.fingerprint.start_line,
                    format!(
                        "public API {} borrows Vec directly where a slice would be more flexible",
                        function.fingerprint.name
                    ),
                    vec![
                        format!("parameter={param_name}"),
                        format!("type={type_text}"),
                    ],
                ));
            }

            if is_borrowed_pathbuf_type(file, &type_text) {
                findings.push(function_finding(
                    file,
                    function,
                    "rust_borrowed_pathbuf_api",
                    Severity::Info,
                    function.fingerprint.start_line,
                    format!(
                        "public API {} borrows PathBuf where &Path would better match the contract",
                        function.fingerprint.name
                    ),
                    vec![
                        format!("parameter={param_name}"),
                        format!("type={type_text}"),
                    ],
                ));
            }
        }
    }

    findings
}

fn bool_param_is_explicit_mode_switch(function: &ParsedFunction, param_name: &str) -> bool {
    let lowered_name = function.fingerprint.name.to_ascii_lowercase();
    let lowered_param = param_name.to_ascii_lowercase();

    lowered_name.contains("_with_")
        || lowered_name.starts_with("with_")
        || [
            "enable_", "disable_", "use_", "with_", "respect_", "allow_", "include_", "exclude_",
        ]
        .iter()
        .any(|prefix| lowered_param.starts_with(prefix))
}