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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

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

pub struct UnusedHeredoc;

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

    fn message(&self) -> String {
        "this here-document has no command to consume it".to_owned()
    }
}

pub fn unused_heredoc(checker: &mut Checker) {
    checker.report_fact_slice_dedup(|facts| facts.unused_heredoc_spans(), || UnusedHeredoc);
}

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

    #[test]
    fn reports_heredocs_without_a_consuming_command() {
        let source = "\
#!/bin/sh
<<EOF
alpha
EOF

x=1 <<EOF
beta
EOF

>out <<EOF
gamma
EOF
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnusedHeredoc));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.start.line)
                .collect::<Vec<_>>(),
            vec![2, 6, 10]
        );
        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec!["<<EOF", "<<EOF", "<<EOF"]
        );
    }

    #[test]
    fn ignores_heredocs_attached_to_commands() {
        let source = "\
#!/bin/sh
cat <<EOF
alpha
EOF

: <<EOF
beta
EOF

\"\" <<EOF
gamma
EOF
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::UnusedHeredoc));

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