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

// SC2065: This is interpreted as a shell file redirection, not a comparison
//
// When > or < appear outside proper test contexts, they're interpreted as
// redirections, not comparison operators. This can cause confusing errors.
//
// Examples:
// Bad:
//   cmd && echo "Success > $file"    // Redirects to $file (confusing)
//   if cmd > /dev/null && echo done  // Redirect, then echo (might be unclear)
//
// Good:
//   cmd && echo "Success: $file"     // Clear message
//   cmd > /dev/null && echo done     // Clearly separate redirect from echo
//   [ $a -gt $b ] && echo "Greater"  // Use proper comparison
//
// Impact: Confusing behavior, unintended redirections

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

static REDIRECT_IN_STRING: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match strings with > or < that might be confusing
    Regex::new(r#"echo\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 mat in REDIRECT_IN_STRING.find_iter(line) {
            let matched_text = mat.as_str();

            // Skip >> and << (append/heredoc redirects are less confusing)
            if matched_text.contains(">>") || matched_text.contains("<<") {
                continue;
            }

            let start_col = mat.start() + 1;
            let end_col = mat.end() + 1;

            let diagnostic = Diagnostic::new(
                "SC2065",
                Severity::Info,
                "This may be interpreted as a shell file redirection. Quote or escape if intentional".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_sc2065_redirect_in_message() {
        let code = r#"echo "Success > $file""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2065_input_redirect() {
        let code = r#"echo "Reading < $input""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2065_clear_message_ok() {
        let code = r#"echo "Success: $file""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_actual_redirect_ok() {
        let code = r#"echo "Success" > $file"#;
        let result = check(code);
        // Actual redirect (outside quotes), OK
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_comparison_ok() {
        let code = r#"[ $a -gt $b ] && echo "Greater""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_comment_ok() {
        let code = r#"# echo "Success > $file""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_single_quotes_ok() {
        let code = r#"echo 'Output > file'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_no_variable_ok() {
        let code = r#"echo "A > B""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_append_redirect() {
        let code = r#"echo "Appended >> $log""#;
        let result = check(code);
        // >> (append redirect) is less confusing than single >, should not warn
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2065_multiple() {
        let code = r#"echo "In: $in > Out: $out""#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }
}