lintje 0.12.0

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

use core::ops::Range;

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

pub struct RebaseCommit {}

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

impl RuleValidator<Commit> for RebaseCommit {
    fn validate(&self, commit: &Commit) -> Option<Vec<Issue>> {
        let subject = &commit.subject;
        let fixup_check = validate_prefix("fixup", subject);
        if fixup_check.is_some() {
            return fixup_check;
        }
        let squash_check = validate_prefix("squash", subject);
        if squash_check.is_some() {
            return squash_check;
        }
        let amend_check = validate_prefix("amend", subject);
        if amend_check.is_some() {
            return amend_check;
        }

        None
    }
}

fn validate_prefix(prefix: &str, subject: &str) -> Option<Vec<Issue>> {
    if subject.starts_with(&format!("{}! ", prefix)) {
        let context = Context::subject_error(
            subject.to_string(),
            Range {
                start: 0,
                end: prefix.len() + 1,
            },
            format!("Rebase {} commits before pushing or merging", prefix),
        );
        Some(vec![Issue::error(
            Rule::RebaseCommit,
            format!("A {} commit was found", prefix),
            Position::Subject { line: 1, column: 1 },
            vec![context],
        )])
    } else {
        None
    }
}

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

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

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

    #[test]
    fn with_valid_subjects() {
        assert_subject_as_valid("I don't need a rebase");
    }

    #[test]
    fn with_fixup_commit() {
        let issue = first_issue(validate(&commit("fixup! I need a rebase", "")));
        assert_eq!(issue.message, "A fixup commit was found");
        assert_eq!(issue.position, subject_position(1));
        assert_contains_issue_output(
            &issue,
            "1 | fixup! I need a rebase\n\
               | ^^^^^^ Rebase fixup commits before pushing or merging",
        );
    }

    #[test]
    fn with_squash_commit() {
        let issue = first_issue(validate(&commit("squash! I need a rebase", "")));
        assert_eq!(issue.message, "A squash commit was found");
        assert_eq!(issue.position, subject_position(1));
        assert_contains_issue_output(
            &issue,
            "1 | squash! I need a rebase\n\
               | ^^^^^^^ Rebase squash commits before pushing or merging",
        );
    }

    #[test]
    fn with_amend_commit() {
        let issue = first_issue(validate(&commit("amend! I need a rebase", "")));
        assert_eq!(issue.message, "A amend commit was found");
        assert_eq!(issue.position, subject_position(1));
        assert_contains_issue_output(
            &issue,
            "1 | amend! I need a rebase\n\
               | ^^^^^^ Rebase amend commits before pushing or merging",
        );
    }
}