shadowplay 0.16.3

Utility for checking puppet syntax, a puppet manifest linter, a pretty printer, and a utility for exploring the Hiera.
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::puppet_parser::range::Range;
use serde::{Deserialize, Serialize};

use crate::puppet_pp_lint::lint::{EarlyLintPass, LintError, LintPass};

#[derive(Clone, Serialize, Deserialize)]
pub struct EmptyCasesList;

impl LintPass for EmptyCasesList {
    fn name(&self) -> &str {
        "EmptyCasesList"
    }
    fn description(&self) -> &str {
        "Warns if case { ... } has no cases"
    }
}

impl EarlyLintPass for EmptyCasesList {
    fn check_case_statement(&self, elt: &crate::puppet_lang::statement::Case<Range>) -> Vec<LintError> {
        if elt.elements.value.is_empty() {
            return vec![LintError::new(
                Box::new(self.clone()),
                "Cases list is empty",
                &elt.extra,
            )];
        }

        vec![]
    }
}

#[derive(Clone, Serialize, Deserialize)]
pub struct DefaultCaseIsNotLast;

impl LintPass for DefaultCaseIsNotLast {
    fn name(&self) -> &str {
        "DefaultCaseIsNotLast"
    }
    fn description(&self) -> &str {
        "Warns if 'default' case is not the last"
    }
}

impl EarlyLintPass for DefaultCaseIsNotLast {
    fn check_case_statement(&self, elt: &crate::puppet_lang::statement::Case<Range>) -> Vec<LintError> {
        let mut default = None;
        let mut errors = Vec::new();
        for case in &elt.elements.value {
            if case
                .matches
                .iter()
                .any(|elt| matches!(elt, crate::puppet_lang::expression::CaseVariant::Default(_)))
            {
                default = Some(case)
            } else if let Some(default) = default {
                errors.push(LintError::new(
                    Box::new(self.clone()),
                    &format!(
                        "Match case after default match which is defined earlier at line {}",
                        default.extra.start().line()
                    ),
                    &elt.extra,
                ))
            }
        }

        errors
    }
}

#[derive(Clone, Serialize, Deserialize)]
pub struct MultipleDefaultCase;

impl LintPass for MultipleDefaultCase {
    fn name(&self) -> &str {
        "MultipleDefaultCase"
    }
    fn description(&self) -> &str {
        "Warns if case statement has multiple 'default' cases"
    }
}

impl EarlyLintPass for MultipleDefaultCase {
    fn check_case_statement(&self, elt: &crate::puppet_lang::statement::Case<Range>) -> Vec<LintError> {
        let mut default: Option<&crate::puppet_lang::statement::CaseElement<Range>> = None;
        let mut errors = Vec::new();
        for case in &elt.elements.value {
            if case
                .matches
                .iter()
                .any(|elt| matches!(elt, crate::puppet_lang::expression::CaseVariant::Default(_)))
            {
                if let Some(default) = default {
                    errors.push(LintError::new(
                        Box::new(self.clone()),
                        &format!(
                            "Default match case is already defined at line {}",
                            default.extra.start().line()
                        ),
                        &elt.extra,
                    ))
                }
                default = Some(case)
            }
        }

        errors
    }
}

#[derive(Clone, Serialize, Deserialize)]
pub struct NoDefaultCase;

impl LintPass for NoDefaultCase {
    fn name(&self) -> &str {
        "NoDefaultCase"
    }
    fn description(&self) -> &str {
        "Warns if case statement has no default case"
    }
}

impl EarlyLintPass for NoDefaultCase {
    fn check_case_statement(&self, elt: &crate::puppet_lang::statement::Case<Range>) -> Vec<LintError> {
        let mut has_default = false;
        for case in &elt.elements.value {
            for case_elt in &case.matches {
                if matches!(case_elt, crate::puppet_lang::expression::CaseVariant::Default(_)) {
                    has_default = true
                }
            }
        }

        if !has_default {
            return vec![LintError::new_with_url(
                Box::new(self.clone()),
                "Case with no default",
                "https://puppet.com/docs/puppet/7/style_guide.html#style_guide_conditionals-case-selector-defaults",
                &elt.extra,
            )];
        }

        vec![]
    }
}