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

// SC2075: Escaping quotes in quotes won't work. Use \\' or \"'\"
//
// In single quotes, nothing can be escaped - not even backslashes.
// To include a single quote in a single-quoted string, you must end the string,
// add an escaped quote, and start a new string.
//
// Examples:
// Incorrect:
//   echo 'can\'t'              // Won't work - backslash is literal
//   msg='it\'s wrong'          // Syntax error
//
// Correct:
//   echo 'can'\''t'            // End string, escaped quote, new string
//   echo "can't"               // Use double quotes instead
//   msg='it'"'"'s fixed'       // End, quote in double quotes, continue
//
// Impact: Syntax errors, incorrect string values

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

static ESCAPED_QUOTE_IN_SINGLE: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match: 'string\'more' (escaped quote inside single quotes)
    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 ESCAPED_QUOTE_IN_SINGLE.find_iter(line) {
            let start_col = mat.start() + 1;
            let end_col = mat.end() + 1;

            let diagnostic = Diagnostic::new(
                "SC2075",
                Severity::Error,
                "Escaping a single quote in single quotes won't work. Use '\"'\"' or double quotes"
                    .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_sc2075_escaped_quote() {
        let code = r#"echo 'can\'t'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2075_its() {
        let code = r#"msg='it\'s broken'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2075_double_quotes_ok() {
        let code = r#"echo "can't""#;
        let result = check(code);
        // Double quotes allow single quotes
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2075_concatenation_ok() {
        let code = r#"echo 'can'"'"'t'"#;
        let result = check(code);
        // Correct workaround (ends string, quotes, starts new)
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2075_plain_string_ok() {
        let code = r#"echo 'hello world'"#;
        let result = check(code);
        // No escaped quotes
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2075_comment_ok() {
        let code = r#"# echo 'can\'t'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2075_double_escape() {
        let code = r#"path='C:\\Users\\file'"#;
        let result = check(code);
        // Backslashes but no quote
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2075_multiple() {
        let code = r#"echo 'don\'t' 'won\'t'"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2075_in_command_sub() {
        let code = r#"result=$(echo 'can\'t')"#;
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2075_escaped_backslash() {
        let code = r#"path='some\\path'"#;
        let result = check(code);
        // Backslash not escaping a quote
        assert_eq!(result.diagnostics.len(), 0);
    }
}