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

//! SC1009: Comment detected where command was expected
//!
//! Detects cases where a comment appears immediately after a control
//! structure keyword (`then`, `do`, `else`, `{`) with no command between.
//! The comment is the only thing where a command body is expected.
//!
//! # Examples
//!
//! Bad:
//! ```bash
//! if true; then
//!     # TODO: implement
//! fi
//! ```
//!
//! Good:
//! ```bash
//! if true; then
//!     : # TODO: implement
//! fi
//! ```

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

/// Keywords after which a command is expected on the next line.
const CONTROL_KEYWORDS: &[&str] = &["then", "do", "else", "{"];

pub fn check(source: &str) -> LintResult {
    let mut result = LintResult::new();
    let lines: Vec<&str> = source.lines().collect();

    for (i, line) in lines.iter().enumerate() {
        let trimmed = line.trim();

        if trimmed.starts_with('#') || trimmed.is_empty() {
            continue;
        }

        // Check if line ends with (or is) a control keyword
        let ends_with_keyword = CONTROL_KEYWORDS
            .iter()
            .any(|kw| trimmed == *kw || trimmed.ends_with(kw));

        if !ends_with_keyword {
            continue;
        }

        // Look at the next non-empty line
        let mut next_idx = i + 1;
        while next_idx < lines.len() && lines[next_idx].trim().is_empty() {
            next_idx += 1;
        }

        if next_idx < lines.len() {
            let next_trimmed = lines[next_idx].trim();
            if next_trimmed.starts_with('#') {
                let line_num = next_idx + 1;
                let col = lines[next_idx].find('#').unwrap_or(0) + 1;
                result.add(Diagnostic::new(
                    "SC1009",
                    Severity::Warning,
                    "Comment here is not a command. Use a no-op `:` if the body is empty",
                    Span::new(line_num, col, line_num, col + next_trimmed.len()),
                ));
            }
        }
    }

    result
}

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

    #[test]
    fn test_sc1009_comment_after_then() {
        let script = "if true; then\n    # todo\nfi";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
        assert_eq!(result.diagnostics[0].code, "SC1009");
        assert_eq!(result.diagnostics[0].severity, Severity::Warning);
    }

    #[test]
    fn test_sc1009_comment_after_do() {
        let script = "for i in 1 2 3; do\n    # process\ndone";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc1009_comment_after_else() {
        let script = "if true; then\n    echo ok\nelse\n    # fallback\nfi";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
    }

    #[test]
    fn test_sc1009_command_after_then_ok() {
        let script = "if true; then\n    echo hello\nfi";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc1009_colon_after_then_ok() {
        let script = "if true; then\n    : # placeholder\nfi";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc1009_comment_not_after_keyword() {
        let script = "echo hello\n# just a comment\necho world";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 0);
    }

    #[test]
    fn test_sc1009_blank_lines_between() {
        let script = "if true; then\n\n    # todo\nfi";
        let result = check(script);
        assert_eq!(result.diagnostics.len(), 1);
    }
}