shuck-linter 0.0.26

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

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

pub struct HeredocMissingEnd;

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

    fn message(&self) -> String {
        "this here-document is missing its closing marker".to_owned()
    }
}

pub fn heredoc_missing_end(checker: &mut Checker) {
    checker.report_fact_slice_dedup(
        |facts| facts.heredoc_missing_end_spans(),
        || HeredocMissingEnd,
    );
}

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

    #[test]
    fn reports_heredoc_without_a_closing_marker() {
        let source = "\
#!/bin/sh
cat <<MARK
line
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::HeredocMissingEnd));

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.start.line, 2);
        assert_eq!(diagnostics[0].span.slice(source), "<<MARK");
    }

    #[test]
    fn reports_unclosed_empty_delimiter_heredoc() {
        let source = "\
#!/bin/sh
cat <<''
line
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::HeredocMissingEnd));

        assert_eq!(diagnostics.len(), 1);
        assert_eq!(diagnostics[0].span.start.line, 2);
        assert_eq!(diagnostics[0].span.slice(source), "<<''");
    }

    #[test]
    fn ignores_closed_heredoc_even_when_delimiter_has_no_trailing_newline() {
        let source = "#!/bin/sh\ncat <<MARK\nline\nMARK";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::HeredocMissingEnd));

        assert!(diagnostics.is_empty());
    }
}