commitguard 0.2.0

A commitlint implementation in Rust
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

use crate::parser::Commit;

use super::{Condition, NoOpts, Rule, Severity};
use miette::{miette, LabeledSpan, Report};

pub struct ScopeEmptyRule {
    pub opts: NoOpts,
}

impl Rule for ScopeEmptyRule {
    fn run(&self, commit: &Commit) -> Option<Report> {
        let severity = &self.opts.0;
        let condition = &self.opts.1;

        if severity == &Severity::Off {
            return None;
        }

        let is_valid = match condition {
            Condition::Never => commit.scope.is_some(),
            Condition::Always => commit.scope.is_none(),
        };

        let mut labels = None;

        if let Some(scope) = &commit.scope {
            labels = Some(vec![LabeledSpan::at(
                scope.start()..scope.end(),
                "not allowed scope",
            )]);
        }

        if !is_valid {
            return Some(
                miette!(
                    severity = match severity {
                        Severity::Warning => miette::Severity::Warning,
                        Severity::Error => miette::Severity::Error,
                        Severity::Off => miette::Severity::Advice,
                    },
                    labels = labels.unwrap_or_default(),
                    help = String::from("scope")
                        + match condition {
                            Condition::Never => " may not be empty",
                            Condition::Always => " must be empty",
                        },
                    code = "rule/scope-empty",
                    url = "https://example.com",
                    "Scope",
                )
                .with_source_code(commit.raw.clone()),
            );
        }

        None
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_empty_scope() {
        let mut commit: Commit<'_> = Default::default();
        commit.scope = None;

        // If the condition is `Never` and the scope is empty, the rule should return an error (read as "the scope should never be empty")
        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Error, Condition::Never),
        };

        assert!(rule.run(&commit).is_some());

        // If the condition is `Always` and the scope is empty, the rule should return `None` (read as "the scope should always be empty")
        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Error, Condition::Always),
        };

        assert!(rule.run(&commit).is_none());
    }

    #[test]
    fn test_filled_scope() {
        let mut commit: Commit<'_> = Default::default();
        commit.scope = Some(Default::default());

        // If the condition is `Never` and the scope is filled, the rule should return `None` (read as "the scope should never be empty")
        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Error, Condition::Never),
        };

        assert!(rule.run(&commit).is_none());

        // If the condition is `Always` and the scope is filled, the rule should return an error (read as "the scope should always be empty")
        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Error, Condition::Always),
        };

        assert!(rule.run(&commit).is_some());
    }

    #[test]
    fn test_severity_off() {
        let mut commit: Commit<'_> = Default::default();
        commit.scope = Some(Default::default());

        // If the severity is `Off`, the rule should return `None`
        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Off, Condition::Never),
        };

        assert!(rule.run(&commit).is_none());

        let rule = ScopeEmptyRule {
            opts: NoOpts(Severity::Off, Condition::Always),
        };

        assert!(rule.run(&commit).is_none());
    }
}