rsconstruct 0.9.124

Rust based fast build system
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

//! The `id` rule: naming convention and uniqueness of job and step IDs.

use std::collections::BTreeMap;
use std::sync::LazyLock;

use regex::Regex;

use super::{Rule, RuleBase};
use crate::engines::actionlint::ast::{Job, Pos, Step, Str};
use crate::engines::actionlint::yaml::go_quote;

static JOB_ID_PATTERN: LazyLock<Regex> =
    LazyLock::new(|| Regex::new(r"^[a-zA-Z_][a-zA-Z0-9_-]*$").expect("valid regex"));

pub struct RuleId {
    base: RuleBase,
    seen: BTreeMap<String, Pos>,
}

impl RuleId {
    pub const fn new() -> Self {
        Self {
            base: RuleBase::new("id"),
            seen: BTreeMap::new(),
        }
    }

    fn validate_convention(&mut self, id: Option<&Str>, what: &str) {
        let Some(id) = id else {
            return;
        };
        if id.value.is_empty() || id.contains_expression() || JOB_ID_PATTERN.is_match(&id.value) {
            return;
        }
        self.base.error(
            id.pos,
            format!(
                "invalid {what} ID {}. {what} ID must start with a letter or _ and contain only alphanumeric characters, -, or _",
                go_quote(&id.value)
            ),
        );
    }
}

impl Rule for RuleId {
    fn base(&mut self) -> &mut RuleBase {
        &mut self.base
    }

    fn visit_job_pre(&mut self, job: &Job) {
        self.seen.clear();
        self.validate_convention(Some(&job.id), "job");
        for j in &job.needs {
            self.validate_convention(Some(j), "job");
        }
    }

    fn visit_job_post(&mut self, _job: &Job) {
        self.seen.clear();
    }

    fn visit_step(&mut self, step: &Step) {
        let Some(id) = &step.id else {
            return;
        };
        self.validate_convention(Some(id), "step");
        let key = id.value.to_lowercase();
        if let Some(prev) = self.seen.get(&key) {
            self.base.error(
                id.pos,
                format!(
                    "step ID {} duplicates. previously defined at {prev}. step ID must be unique within a job. note that step ID is case insensitive",
                    go_quote(&id.value)
                ),
            );
            return;
        }
        self.seen.insert(key, id.pos);
    }
}