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

use ra_ap_syntax::{AstNode, ast};

use crate::{AstCtx, Example, Violation};

#[rustfmt::skip]
const EXAMPLES: &[Example] = &[
    Example {
        label: "process::exit in library",
        code: "fn f() { std::process::exit(1); }",
        pass: false,
    },
    Example {
        label: "no exit call",
        code: "fn f() { let exit = 0; }",
        pass: true,
    },
    Example {
        label: "exit in test module",
        code: "#[cfg(test)]\nmod tests {\n    fn t() { std::process::exit(1); }\n}",
        pass: true,
    },
    Example {
        label: "custom exit function",
        code: "fn f() { exit(0); }",
        pass: true,
    },
];

crate::ast_rule!(
    deep_exit,
    "Ban `std::process::exit()` in library code.",
    "process::exit() skips destructors and cleanup. Return Result from main instead so resources are released properly.",
    High,
);

fn check_deep_exit(ctx: &AstCtx<'_>) -> Vec<Violation> {
    ctx.nodes::<ast::CallExpr>()
        .filter(|call| !ctx.is_in_test(call))
        .filter_map(|call| {
            let ast::Expr::PathExpr(path_expr) = call.expr()? else {
                return None;
            };
            let path = path_expr.path()?;
            let source = path.syntax().text().to_string();

            (source.split("::").any(|segment| segment == "process")
                && path
                    .segment()
                    .and_then(|segment| segment.name_ref())
                    .is_some_and(|name| name.text() == "exit"))
            .then(|| {
                ctx.violation(
                    &path,
                    "process::exit() in library code (return Result instead)",
                )
            })
        })
        .collect()
}

crate::rulewright_ast_test!(check_deep_exit, {
    crate::example_tests!(EXAMPLES, check_deep_exit);
});