shuck-linter 0.0.41

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

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

pub struct SpaceyAssign;

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

    fn message(&self) -> String {
        "assignment spacing makes this run as a command".to_owned()
    }
}

pub fn spacey_assign(checker: &mut Checker) {
    if checker.shell() == ShellDialect::Zsh {
        return;
    }

    checker.report_fact_slice_dedup(
        |facts| facts.command_facts().spacey_assignment_spans(),
        || SpaceyAssign,
    );
}

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

    #[test]
    fn reports_variable_like_commands_followed_by_equals_words() {
        let source = "\
#!/bin/sh
name = demo
empty =
joined =demo
read = value
test = foo
time = 1
FOO=1 name = value
time timed = value
time FOO=1 timed = value
f() { inside = \"$value\"; }
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::SpaceyAssign));

        assert_eq!(
            diagnostics
                .iter()
                .map(|diagnostic| diagnostic.span.slice(source))
                .collect::<Vec<_>>(),
            vec![
                "name = demo",
                "empty =",
                "joined =demo",
                "read = value",
                "test = foo",
                "time = 1",
                "name = value",
                "timed = value",
                "timed = value",
                "inside = \"$value\""
            ]
        );
    }

    #[test]
    fn ignores_assignments_declarations_comparisons_and_quoted_equals() {
        let source = "\
#!/bin/sh
name=value
name= value
export name = demo
name == demo
name \"=\" demo
name \\= demo
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::SpaceyAssign));

        assert!(diagnostics.is_empty());
    }

    #[test]
    fn skips_zsh() {
        let source = "\
#!/bin/zsh
name = demo
";
        let diagnostics = test_snippet(source, &LinterSettings::for_rule(Rule::SpaceyAssign));

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