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

// SC2276: Avoid useless cat with here documents
use crate::linter::{Diagnostic, LintResult, Severity, Span};
use regex::Regex;

static CAT_HEREDOC: std::sync::LazyLock<Regex> =
    std::sync::LazyLock::new(|| Regex::new(r"cat\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;
        }

        if CAT_HEREDOC.is_match(line) {
            let diagnostic = Diagnostic::new(
                "SC2276",
                Severity::Info,
                "Avoid useless cat - use here document directly".to_string(),
                Span::new(line_num, 1, line_num, line.len() + 1),
            );
            result.add(diagnostic);
        }
    }
    result
}

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

    #[test]
    fn test_sc2276_cat_heredoc() {
        let code = "cat << EOF";
        assert_eq!(check(code).diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2276_direct_heredoc_ok() {
        let code = "command << EOF";
        assert_eq!(check(code).diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_cat_file_ok() {
        let code = "cat file.txt";
        assert_eq!(check(code).diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_comment() {
        let code = "# cat << EOF";
        assert_eq!(check(code).diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_empty() {
        assert_eq!(check("").diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_normal() {
        assert_eq!(check("echo test").diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_cat_heredoc_dash() {
        let code = "cat <<- EOF";
        assert_eq!(check(code).diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2276_cat_here_string_ok() {
        let code = "cat <<< '$var'";
        assert_eq!(check(code).diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_concatenate_ok() {
        let code = "cat file1 file2";
        assert_eq!(check(code).diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2276_pipe_to_cat_ok() {
        let code = "echo test | cat";
        assert_eq!(check(code).diagnostics.len(), 0);
    }
}