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

// SC2176: 'time' is undefined for pipelines. Time individual commands.
//
// The 'time' keyword behavior with pipelines varies across shells.
//
// Examples:
// Bad:
//   time cmd1 | cmd2             // Undefined which is timed
//
// Good:
//   time { cmd1 | cmd2; }        // Time the whole pipeline
//   time cmd1                     // Time single command
//
// Impact: Unclear what is being measured

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

static TIME_WITH_PIPE: std::sync::LazyLock<Regex> = std::sync::LazyLock::new(|| {
    // Match: time cmd1 | cmd2
    // Exclude: time { cmd1 | cmd2 } (has braces)
    // Exclude: time ( cmd1 | cmd2 ) (has subshell)
    Regex::new(r"\btime\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 TIME_WITH_PIPE.find_iter(line) {
            let start_col = mat.start() + 1;
            let end_col = mat.end() + 1;

            let diagnostic = Diagnostic::new(
                "SC2176",
                Severity::Warning,
                "'time' with pipelines is undefined. Use 'time { cmd1 | cmd2; }'".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_sc2176_time_pipe() {
        let code = "time cmd1 | cmd2";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2176_time_single_ok() {
        let code = "time cmd1";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_time_group_ok() {
        let code = "time { cmd1 | cmd2; }";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_comment_ok() {
        let code = "# time cmd1 | cmd2";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_multiple() {
        let code = "time cmd1 | cmd2\ntime cmd3 | cmd4";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 2);
    }

    #[test]
    fn test_sc2176_time_subshell_ok() {
        let code = "time ( cmd1 | cmd2 )";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_time_complex_pipe() {
        let code = "time grep foo bar | sort | uniq";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc2176_no_time_ok() {
        let code = "cmd1 | cmd2";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_time_and_ok() {
        let code = "time cmd1 && cmd2";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc2176_time_semicolon_ok() {
        let code = "time cmd1; cmd2 | cmd3";
        let result = check(code);
        assert_eq!(result.diagnostics.len(), 0);
    }
}