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

// SC2131: Escape backslashes in single quotes to avoid confusion
//
// Backslashes in single quotes are LITERAL. They don't escape anything.
// To get a literal backslash, just use it. To escape quotes, exit single quotes.
//
// Examples:
// Bad:
//   echo 'path\\to\\file'      // Has literal \\ (not \\)
//   echo 'can\'t'              // Doesn't work - backslash is literal
//
// Good:
//   echo 'path\to\file'        // Single backslash is literal
//   echo 'can'"'"'t'           // Proper quote escaping
//   echo "can't"               // Use double quotes for contractions
//
// Impact: Confusion about escaping in single quotes

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

static DOUBLE_BACKSLASH_SINGLE_QUOTE: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match: '...\\'...'' patterns with double backslashes
    Regex::new(r"'[^']*\\\\[^']*'").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 DOUBLE_BACKSLASH_SINGLE_QUOTE.find_iter(line) {
            let matched = mat.as_str();

            // Check if it contains \\ (double backslash)
            if matched.contains("\\\\") {
                let start_col = mat.start() + 1;
                let end_col = mat.end() + 1;

                let diagnostic = Diagnostic::new(
                    "SC2131",
                    Severity::Info,
                    "Backslashes in single quotes are literal. Use single \\ for literal backslash"
                        .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_sc2131_double_backslash() {
        let code = r#"echo 'path\\to\\file'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2131_single_backslash_ok() {
        let code = "echo 'path\\to\\file'";
        let result = check(code);
        // Single backslash is literal and correct
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2131_double_quotes_ok() {
        let code = r#"echo "path\\to\\file""#;
        let result = check(code);
        // Double quotes - backslashes escape
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2131_comment_ok() {
        let code = r#"# echo 'path\\to\\file'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2131_regex_pattern() {
        let code = r#"pattern='[0-9]\\+'"#;
        let result = check(code);
        // Regex pattern with escaped +
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2131_multiline() {
        let code = r#"
path='C:\\Users\\Documents'
echo "$path"
"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2131_multiple() {
        let code = r#"
a='path\\1'
b='path\\2'
"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2131_windows_path() {
        let code = r#"winpath='C:\\Windows\\System32'"#;
        let result = check(code);
        // Windows path with double backslashes
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2131_no_backslash_ok() {
        let code = "echo 'hello world'";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2131_escaped_newline() {
        let code = r#"text='line1\\nline2'"#;
        let result = check(code);
        // \\n doesn't expand in single quotes
        assert_eq!(result.diagnostics.len(), 1);
    }
}