shuck-linter 0.0.40

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

use shuck_ast::{
    Span, Word, static_word_text, word_span_is_plain_parameter_reference,
    word_span_is_zsh_presence_test,
};
use shuck_semantic::{BindingId, Reference, ReferenceKind};

use crate::{Checker, ShellDialect};

pub(crate) fn word_expands_only_static_pattern_safe_literals(
    checker: &Checker<'_>,
    word: &Word,
) -> bool {
    span_expands_only_static_pattern_safe_literals(
        checker,
        word.span,
        word_span_is_plain_parameter_reference(word, word.span),
        word_span_is_zsh_presence_test(word, word.span),
    )
}

pub(crate) fn span_expands_only_static_pattern_safe_literals(
    checker: &Checker<'_>,
    span: Span,
    is_plain_parameter_reference: bool,
    is_zsh_presence_test: bool,
) -> bool {
    if checker.shell() != ShellDialect::Zsh {
        return false;
    }
    if is_zsh_presence_test {
        return true;
    }
    if !is_plain_parameter_reference {
        return false;
    }

    let mut references = checker
        .semantic()
        .references_in_span(span)
        .filter(|reference| reference_kind_can_name_pattern_operand_value(reference.kind));
    let Some(reference) = references.next() else {
        return false;
    };
    if references.next().is_some() {
        return false;
    }

    reference_expands_only_static_pattern_safe_literals(checker, reference)
}

fn reference_kind_can_name_pattern_operand_value(kind: ReferenceKind) -> bool {
    matches!(
        kind,
        ReferenceKind::Expansion
            | ReferenceKind::ParameterExpansion
            | ReferenceKind::ArrayAccess
            | ReferenceKind::ParameterPattern
            | ReferenceKind::ConditionalOperand
    )
}

fn reference_expands_only_static_pattern_safe_literals(
    checker: &Checker<'_>,
    reference: &Reference,
) -> bool {
    let bindings = checker
        .semantic_analysis()
        .reaching_bindings_for_name(&reference.name, reference.span);
    !bindings.is_empty()
        && bindings
            .iter()
            .all(|binding_id| binding_expands_to_static_pattern_safe_literal(checker, *binding_id))
}

fn binding_expands_to_static_pattern_safe_literal(
    checker: &Checker<'_>,
    binding_id: BindingId,
) -> bool {
    checker
        .facts()
        .binding_value(binding_id)
        .and_then(|value| value.scalar_word())
        .and_then(|word| static_word_text(word, checker.source()))
        .is_some_and(|text| static_literal_is_pattern_safe(&text))
}

fn static_literal_is_pattern_safe(text: &str) -> bool {
    text.bytes().all(|byte| {
        byte.is_ascii_alphanumeric()
            || matches!(
                byte,
                b' ' | b'_' | b'-' | b'.' | b'/' | b':' | b',' | b'=' | b'@'
            )
    })
}