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

// SC2077: Quote regex parameter in =~ to prevent word splitting
//
// When using =~ in [[ ]], variables containing regex patterns should typically
// be unquoted to allow pattern matching. However, if you want literal matching,
// quote the pattern or use a variable.
//
// Examples:
// Bad (if pattern has spaces):
//   pattern="foo bar"
//   [[ $text =~ $pattern ]]    // Word splits, matches "foo" OR "bar"
//
// Good:
//   [[ $text =~ "$pattern" ]]  // Literal match for "foo bar"
//   [[ $text =~ foo\ bar ]]    // Escaped space in pattern
//
// Impact: Unexpected pattern matching behavior

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

static REGEX_WITH_UNQUOTED_VAR: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match: [[ ... =~ $var ]] or [[ ... =~ ${var} ]] (unquoted variable in regex position)
    Regex::new(r"\[\[[^\]]*=~\s+\$(\{[a-zA-Z_][a-zA-Z0-9_]*\}|[a-zA-Z_][a-zA-Z0-9_]*)[^\]]*\]\]")
        .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;
        }

        // This is a style preference - flagging for awareness
        // Some prefer unquoted for regex, quoted for literal
        for mat in REGEX_WITH_UNQUOTED_VAR.find_iter(line) {
            let start_col = mat.start() + 1;
            let end_col = mat.end() + 1;

            let diagnostic = Diagnostic::new(
                "SC2077",
                Severity::Info,
                "Regex variable pattern may word split. Quote for literal match or ensure no spaces"
                    .to_string(),
                Span::new(line_num, start_col, line_num, end_col),
            );

            result.add(diagnostic);
        }
    }

    result
}

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

    #[test]
    fn test_sc2077_unquoted_var() {
        let code = r#"[[ $text =~ $pattern ]]"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2077_with_condition() {
        let code = r#"if [[ $text =~ $regex ]]; then echo "match"; fi"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2077_quoted_ok() {
        let code = r#"[[ $text =~ "$pattern" ]]"#;
        let result = check(code);
        // Quoted is OK (literal match)
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2077_literal_pattern_ok() {
        let code = r#"[[ $text =~ [0-9]+ ]]"#;
        let result = check(code);
        // Literal regex pattern, not a variable
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2077_comment_ok() {
        let code = r#"# [[ $text =~ $pattern ]]"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2077_braced_var() {
        let code = r#"[[ $text =~ ${pattern} ]]"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2077_negation() {
        let code = r#"[[ ! $text =~ $pattern ]]"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2077_escaped_space() {
        let code = r#"[[ $text =~ foo\ bar ]]"#;
        let result = check(code);
        // Escaped space in literal pattern
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2077_multiple() {
        let code = r#"[[ $a =~ $p1 ]] && [[ $b =~ $p2 ]]"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2077_single_bracket_ignored() {
        let code = r#"[ $text = $pattern ]"#;
        let result = check(code);
        // Single bracket uses different rule
        assert_eq!(result.diagnostics.len(), 0);
    }
}