shuck-linter 0.0.43

Lint rule engine and checker for shell scripts
Documentation 
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

use crate::{Checker, Rule, Violation};

pub struct MissingFileDescription;

impl Violation for MissingFileDescription {
    fn rule() -> Rule {
        Rule::MissingFileDescription
    }

    fn message(&self) -> String {
        "add a file header comment describing the script".to_owned()
    }
}

pub fn missing_file_description(checker: &mut Checker) {
    let Some(fact) = checker
        .facts()
        .source_facts()
        .missing_file_description_comment()
    else {
        return;
    };

    if fact.is_shebang_only_file() && checker.rule_options().s081.ignore_shebang_only_files {
        return;
    }

    checker.report(MissingFileDescription, fact.span());
}

#[cfg(test)]
mod tests {
    use crate::test::test_snippet;
    use crate::{LinterSettings, Rule};

    #[test]
    fn reports_code_immediately_after_shebang() {
        let source = "#!/bin/bash\nls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.slice(source), "ls -la");
    }

    #[test]
    fn reports_code_after_shebang_with_leading_blank_lines() {
        let source = "\n#!/bin/bash\nls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.slice(source), "ls -la");
    }

    #[test]
    fn accepts_comment_block_after_shebang() {
        let source = "#!/bin/bash\n# Lists the current directory.\nls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert!(diagnostics.is_empty(), "diagnostics: {diagnostics:?}");
    }

    #[test]
    fn accepts_comment_block_after_shebang_and_blank_lines() {
        let source = "#!/bin/bash\n\n# Lists the current directory.\nls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert!(diagnostics.is_empty(), "diagnostics: {diagnostics:?}");
    }

    #[test]
    fn reports_code_first_files_without_shebang() {
        let source = "ls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.slice(source), "ls -la");
    }

    #[test]
    fn accepts_comment_first_files_without_shebang() {
        let source = "# Lists the current directory.\nls -la\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert!(diagnostics.is_empty(), "diagnostics: {diagnostics:?}");
    }

    #[test]
    fn reports_shebang_only_files_by_default() {
        let source = "#!/bin/bash\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription),
        );

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.slice(source), "#!/bin/bash");
    }

    #[test]
    fn can_ignore_shebang_only_files() {
        let source = "#!/bin/bash\n";
        let diagnostics = test_snippet(
            source,
            &LinterSettings::for_rule(Rule::MissingFileDescription)
                .with_s081_ignore_shebang_only_files(true),
        );

        assert!(diagnostics.is_empty(), "diagnostics: {diagnostics:?}");
    }
}