lintje 0.11.2

Lintje is an opinionated linter for Git.
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
146

use core::ops::Range;

use crate::commit::Commit;
use crate::issue::{Context, Issue, Position};
use crate::rule::Rule;
use crate::rule::RuleValidator;

const MOOD_WORDS: [&str; 41] = [
    "fixed",
    "fixes",
    "fixing",
    "solved",
    "solves",
    "solving",
    "resolved",
    "resolves",
    "resolving",
    "closed",
    "closes",
    "closing",
    "added",
    "adding",
    "updated",
    "updates",
    "updating",
    "removed",
    "removes",
    "removing",
    "deleted",
    "deletes",
    "deleting",
    "changed",
    "changes",
    "changing",
    "moved",
    "moves",
    "moving",
    "refactored",
    "refactors",
    "refactoring",
    "checked",
    "checks",
    "checking",
    "adjusted",
    "adjusts",
    "adjusting",
    "tests",
    "tested",
    "testing",
];

pub struct SubjectMood {}

impl SubjectMood {
    pub fn new() -> Self {
        Self {}
    }
}

impl RuleValidator<Commit> for SubjectMood {
    fn validate(&self, commit: &Commit) -> Option<Vec<Issue>> {
        match commit.subject.split(' ').next() {
            Some(raw_word) => {
                let word = raw_word.to_lowercase();
                if MOOD_WORDS.contains(&word.as_str()) {
                    let context = vec![Context::subject_error(
                        commit.subject.to_string(),
                        Range {
                            start: 0,
                            end: word.len(),
                        },
                        "Use the imperative mood for the subject".to_string(),
                    )];
                    Some(vec![Issue::error(
                        Rule::SubjectMood,
                        "The subject does not use the imperative grammatical mood".to_string(),
                        Position::Subject { line: 1, column: 1 },
                        context,
                    )])
                } else {
                    None
                }
            }
            None => {
                error!("SubjectMood validation failure: No first word found of commit subject.");
                None
            }
        }
    }
}

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

    fn validate(commit: &Commit) -> Option<Vec<Issue>> {
        SubjectMood::new().validate(commit)
    }

    fn assert_subject_as_valid(subject: &str) {
        assert_eq!(validate(&commit(subject, "")), None);
    }

    fn assert_subject_as_invalid(subject: &str) {
        assert!(validate(&commit(subject, "")).is_some());
    }

    #[test]
    fn with_valid_subjects() {
        assert_subject_as_valid("Fix test");
        assert_subject_as_valid("Fix tests");
    }

    #[test]
    fn with_flagged_mood_words() {
        let mut invalid_subjects = vec![];
        for word in MOOD_WORDS.iter() {
            invalid_subjects.push(format!("{} test", word));
            let mut chars = word.chars();
            let capitalized_word = match chars.next() {
                None => panic!("Could not capitalize word: {}", word),
                Some(letter) => letter.to_uppercase().collect::<String>() + chars.as_str(),
            };
            invalid_subjects.push(format!("{} test", capitalized_word));
        }
        for subject in invalid_subjects {
            assert_subject_as_invalid(subject.as_str());
        }
    }

    #[test]
    fn with_cliche_subject() {
        let issue = first_issue(validate(&commit("Fixing bug", "")));
        assert_eq!(
            issue.message,
            "The subject does not use the imperative grammatical mood"
        );
        assert_eq!(issue.position, subject_position(1));
        assert_contains_issue_output(
            &issue,
            "1 | Fixing bug\n\
               | ^^^^^^ Use the imperative mood for the subject",
        );
    }
}