slopguard_core/
disable.rs

1use crate::finding::Finding;
2use crate::rule::RuleId;
3
4const DISABLE_MARKER: &str = "slopguard-disable-next-line";
5
6struct DisableDirective {
7    target_line: usize,
8    rule_id: Option<RuleId>,
9}
10
11fn parse_directives(source: &str) -> Vec<DisableDirective> {
12    source
13        .lines()
14        .enumerate()
15        .filter_map(|(idx, line)| {
16            let rest = line
17                .trim()
18                .strip_prefix("//")?
19                .trim()
20                .strip_prefix(DISABLE_MARKER)?;
21            let rest = rest.trim();
22            Some(DisableDirective {
23                target_line: idx + 2,
24                rule_id: (!rest.is_empty()).then(|| RuleId::from(rest)),
25            })
26        })
27        .collect()
28}
29
30/// Filter out findings that are suppressed by `// slopguard-disable-next-line`
31/// comments in the source code.
32pub fn filter_disabled(findings: Vec<Finding>, source: &str) -> Vec<Finding> {
33    let directives = parse_directives(source);
34    if directives.is_empty() {
35        return findings;
36    }
37    findings
38        .into_iter()
39        .filter(|finding| {
40            !directives.iter().any(|d| {
41                d.target_line == finding.line
42                    && d.rule_id.as_ref().is_none_or(|id| *id == finding.rule_id)
43            })
44        })
45        .collect()
46}
47
48#[cfg(test)]
49mod tests {
50    use std::path::PathBuf;
51
52    use crate::finding::Finding;
53    use crate::rule::{Category, RuleId, Severity};
54
55    use super::filter_disabled;
56
57    fn make_finding(rule_id: &str, line: usize) -> Finding {
58        Finding {
59            rule_id: RuleId::from(rule_id),
60            severity: Severity::Error,
61            category: Category::Correctness,
62            message: "test".to_string(),
63            note: None,
64            fix: None,
65            file: PathBuf::from("test.rs"),
66            line,
67            column: 1,
68            end_line: line,
69            end_column: 10,
70            matched_text: "test".to_string(),
71        }
72    }
73
74    #[test]
75    fn disable_without_rule_id_suppresses_all_findings() {
76        let source = "fn main() {\n    // slopguard-disable-next-line\n    foo().unwrap();\n}\n";
77        let findings = vec![
78            make_finding("no-unwrap-in-prod", 3),
79            make_finding("no-expect-in-prod", 3),
80        ];
81        let result = filter_disabled(findings, source);
82        assert!(
83            result.is_empty(),
84            "all findings on the disabled line should be suppressed"
85        );
86    }
87
88    #[test]
89    fn disable_with_rule_id_suppresses_only_that_rule() {
90        let source = "fn main() {\n    // slopguard-disable-next-line no-unwrap-in-prod\n    foo().unwrap();\n}\n";
91        let findings = vec![
92            make_finding("no-unwrap-in-prod", 3),
93            make_finding("other-rule", 3),
94        ];
95        let result = filter_disabled(findings, source);
96        assert_eq!(result.len(), 1);
97        assert_eq!(result[0].rule_id, RuleId::from("other-rule"));
98    }
99
100    #[test]
101    fn disable_with_unknown_rule_id_suppresses_nothing() {
102        let source = "fn main() {\n    // slopguard-disable-next-line nonexistent-rule\n    foo().unwrap();\n}\n";
103        let findings = vec![make_finding("no-unwrap-in-prod", 3)];
104        let result = filter_disabled(findings, source);
105        assert_eq!(result.len(), 1);
106        assert_eq!(result[0].rule_id, RuleId::from("no-unwrap-in-prod"));
107    }
108
109    #[test]
110    fn disable_on_wrong_line_suppresses_nothing() {
111        let source = "// slopguard-disable-next-line\nfn main() {\n    foo().unwrap();\n}\n";
112        let findings = vec![make_finding("no-unwrap-in-prod", 3)];
113        let result = filter_disabled(findings, source);
114        assert_eq!(result.len(), 1);
115    }
116
117    #[test]
118    fn disable_with_spacing_variants() {
119        let source_no_space =
120            "fn main() {\n    //slopguard-disable-next-line\n    foo().unwrap();\n}\n";
121        let findings1 = vec![make_finding("no-unwrap-in-prod", 3)];
122        assert!(filter_disabled(findings1, source_no_space).is_empty());
123
124        let source_extra_spaces =
125            "fn main() {\n    //  slopguard-disable-next-line\n    foo().unwrap();\n}\n";
126        let findings2 = vec![make_finding("no-unwrap-in-prod", 3)];
127        assert!(filter_disabled(findings2, source_extra_spaces).is_empty());
128
129        let source_leading_space =
130            "fn main() {\n      // slopguard-disable-next-line\n    foo().unwrap();\n}\n";
131        let findings3 = vec![make_finding("no-unwrap-in-prod", 3)];
132        assert!(filter_disabled(findings3, source_leading_space).is_empty());
133    }
134
135    #[test]
136    fn disable_without_rule_id_multiple_findings_same_line() {
137        let source = "fn main() {\n    // slopguard-disable-next-line\n    foo().unwrap();\n}\n";
138        let findings = vec![
139            make_finding("rule-a", 3),
140            make_finding("rule-b", 3),
141            make_finding("rule-c", 3),
142        ];
143        let result = filter_disabled(findings, source);
144        assert!(result.is_empty());
145    }
146
147    #[test]
148    fn disable_with_rule_id_multiple_findings_same_line() {
149        let source =
150            "fn main() {\n    // slopguard-disable-next-line rule-b\n    foo().unwrap();\n}\n";
151        let findings = vec![
152            make_finding("rule-a", 3),
153            make_finding("rule-b", 3),
154            make_finding("rule-c", 3),
155        ];
156        let result = filter_disabled(findings, source);
157        assert_eq!(result.len(), 2);
158        assert_eq!(result[0].rule_id, RuleId::from("rule-a"));
159        assert_eq!(result[1].rule_id, RuleId::from("rule-c"));
160    }
161
162    #[test]
163    fn no_disable_comments_returns_all_findings() {
164        let source = "fn main() {\n    foo().unwrap();\n}\n";
165        let findings = vec![make_finding("no-unwrap-in-prod", 2)];
166        let result = filter_disabled(findings, source);
167        assert_eq!(result.len(), 1);
168    }
169
170    #[test]
171    fn disable_on_last_line_no_panic() {
172        let source = "fn main() {}\n// slopguard-disable-next-line";
173        let findings: Vec<Finding> = vec![];
174        let result = filter_disabled(findings, source);
175        assert!(result.is_empty());
176    }
177}
slopguard_core/disable.rs

slopguard_core/
disable.rs
