rulewright 0.1.1

Executable engineering standards for Rust workspaces
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

use crate::{
    Example, FileCtx, Violation,
    infra::{helpers, parse, scanner},
    violation,
};

#[rustfmt::skip]
const EXAMPLES: &[Example] = &[
    Example {
        label: "outer allow",
        code: "#[allow(dead_code)]\nfn f() {}",
        pass: false,
    },
    Example {
        label: "inner allow",
        code: "#![allow(clippy::too_many_arguments)]",
        pass: false,
    },
    Example {
        label: "allow with comment still flagged",
        code: "#[allow(dead_code)] // webhook response fields",
        pass: false,
    },
    Example {
        label: "expect with reason",
        code: "#[expect(dead_code, reason = \"kept for wire format\")]\nfn f() {}",
        pass: true,
    },
    Example {
        label: "allow inside macro_rules body",
        code: "macro_rules! m {\n    () => {\n        #[allow(unused)]\n        fn f() {}\n    };\n}",
        pass: true,
    },
    Example {
        label: "allow after macro_rules closed",
        code: "macro_rules! m {\n    () => {};\n}\n#[allow(unused)]\nfn f() {}",
        pass: false,
    },
    Example {
        label: "allow in comment",
        code: "// #[allow(dead_code)]",
        pass: true,
    },
    Example {
        label: "allow in string literal",
        code: "fn f() { let s = \"#[allow(dead_code)]\"; }",
        pass: true,
    },
];

crate::line_rule!(
    expect_over_allow,
    "Flag `#[allow(...)]` in hand-written code — use `#[expect(..., reason = \"...\")]` instead.",
    "#[expect] warns when the suppressed lint no longer fires, preventing stale suppressions from accumulating; #[allow] silences forever (clippy analogue: allow_attributes).",
    Medium,
);

fn check_expect_over_allow(ctx: &FileCtx<'_>) -> Vec<Violation> {
    let mut out = Vec::new();
    let mut in_macro = false;
    let mut brace_depth: usize = 0;
    let mut seen_brace = false;

    for (i, line) in ctx.lines.iter().enumerate() {
        let trimmed = line.trim();

        if parse::is_comment(trimmed) {
            continue;
        }

        let code = scanner::code_only(line);

        if !in_macro && code.contains("macro_rules!") {
            in_macro = true;
            brace_depth = 0;
            seen_brace = false;
        }

        if in_macro {
            for ch in code.chars() {
                match ch {
                    '{' => {
                        brace_depth += 1;
                        seen_brace = true;
                    }
                    '}' => brace_depth = brace_depth.saturating_sub(1),
                    _ => {}
                }
            }

            if seen_brace && brace_depth == 0 {
                in_macro = false;
            }

            continue;
        }

        if helpers::contains_outside_strings(line, "#[allow(")
            || helpers::contains_outside_strings(line, "#![allow(")
        {
            out.push(violation(
                ctx.rel,
                i + 1,
                "#[allow(...)] — use #[expect(..., reason = \"...\")] so stale suppressions warn",
            ));
        }
    }

    out
}

crate::rulewright_test!(check_expect_over_allow, {
    crate::example_tests!(EXAMPLES, check_expect_over_allow);
});