bashrs 6.66.0

Rust-to-Shell transpiler for deterministic bootstrap scripts
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

// SC2158: [ false ] is true. Remove the brackets or use `! false`
//
// The `false` command returns exit status 1, but when used inside test brackets
// like `[ false ]`, it's testing if the STRING "false" is non-empty, which is always true.
//
// Examples:
// Bad:
//   if [ false ]; then  # Always true! Tests if string "false" is non-empty
//   if [ true ]; then   # Also always true
//
// Good:
//   if false; then      # Correctly tests exit status
//   if ! false; then    # Correctly inverts exit status
//   if true; then       # Correctly tests exit status

use crate::linter::{Diagnostic, LintResult, Severity, Span};
use regex::Regex;

static LITERAL_BOOL_IN_BRACKETS: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match: [ false ] or [ true ] (literal commands treated as strings)
    // Only match single brackets, not [[
    Regex::new(r"(?:^|[^\[])\[\s+(true|false)\s+\]").unwrap()
});

pub fn check(source: &str) -> LintResult {
    let mut result = LintResult::new();

    for (line_num, line) in source.lines().enumerate() {
        let line_num = line_num + 1;

        if line.trim_start().starts_with('#') {
            continue;
        }

        for cap in LITERAL_BOOL_IN_BRACKETS.captures_iter(line) {
            if let Some(command) = cap.get(1) {
                let start_col = cap.get(0).unwrap().start() + 1;
                let end_col = cap.get(0).unwrap().end() + 1;

                let cmd_text = command.as_str();
                let expected = if cmd_text == "false" {
                    "always true"
                } else {
                    "always false"
                };

                let diagnostic = Diagnostic::new(
                    "SC2158",
                    Severity::Warning,
                    format!(
                        "[ {} ] is {}. Remove the brackets or use the command directly",
                        cmd_text, expected
                    ),
                    Span::new(line_num, start_col, line_num, end_col),
                );

                result.add(diagnostic);
            }
        }
    }

    result
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_sc2158_false_in_brackets() {
        let code = r#"if [ false ]; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
        assert_eq!(result.diagnostics[0].code, "SC2158");
        assert_eq!(result.diagnostics[0].severity, Severity::Warning);
        assert!(result.diagnostics[0].message.contains("false"));
        assert!(result.diagnostics[0].message.contains("always true"));
    }

    #[test]
    fn test_sc2158_true_in_brackets() {
        let code = r#"if [ true ]; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
        assert!(result.diagnostics[0].message.contains("true"));
    }

    #[test]
    fn test_sc2158_false_without_brackets_ok() {
        let code = r#"if false; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_true_without_brackets_ok() {
        let code = r#"if true; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_negated_false_ok() {
        let code = r#"if ! false; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_double_brackets() {
        let code = r#"if [[ false ]]; then"#;
        let result = check(code);
        // Our regex only catches single brackets
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_variable_named_false_ok() {
        let code = r#"if [ "$false" ]; then"#;
        let result = check(code);
        // Variable reference, not literal
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_command_in_brackets_ok() {
        let code = r#"if [ -f false ]; then"#;
        let result = check(code);
        // Testing file named "false", not literal command
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2158_multiple_on_line() {
        let code = r#"if [ false ] || [ true ]; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2158_false_with_extra_spaces() {
        let code = r#"if [  false  ]; then"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }
}