gitru 0.2.11

a lightweight, configurable Git commit message validation tool
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

use thiserror::Error;

#[derive(Debug, Error, PartialEq)]
pub enum HeaderError {
    #[error(
        r###"invalid header format: {0}

Invalid commit header format. Please use the following format:
  type(scope)!: subject

Examples:
  feat(parser): add parsing feature
  fix: resolve boundary issue
  🔥optimize: improve performance

Explanation:
  - type: commit type (supports Chinese, emoji)
  - scope: optional, wrapped in parentheses
  - !: optional, indicates breaking change
  - subject: commit description
"###
    )]
    InvalidHeaderFormat(String),

    #[error("full-width colon is not allowed (use half-width colon ':')")]
    FullWidthColonNotAllowed,

    #[error("header cannot be empty")]
    EmptyHeader,

    #[error("missing colon separator, use format `type: subject`")]
    MissingColon,

    // Type validation module
    #[error("commit type cannot be empty, e.g. `feat: xxx`")]
    EmptyType,

    #[error(
        "allowed_types is empty, If you don't need type validation, remove or comment out the entire allowed_types field instead."
    )]
    EmptyAllowedTypes,

    #[error("commit type `{0}` contains invalid characters, use letters, numbers, or emoji")]
    InvalidType(String),

    #[error("commit type `{type}` is not in the allowed list, allowed types are {allowed_types:?}")]
    NotAllowedType {
        r#type: String,
        allowed_types: Vec<String>,
    },

    #[error(
        "unknown commit type `{wrong}`\n\
     help: did you mean `{correct}`? (similarity {similarity:.2})\n\
     note: allowed types: {allowed_types:?}"
    )]
    TypeTypo {
        wrong: String,
        correct: String,
        similarity: f64,
        allowed_types: Vec<String>,
    },

    // Scope validation module
    #[error("scope missing right parenthesis: `{left}`\nExample: `feat(parser): xxx`")]
    MissingRightParen { left: String },

    #[error("scope missing left parenthesis: `{left}`\nExample: `feat(parser): xxx`")]
    MissingLeftParen { left: String },

    #[error("scope `{0}` format is invalid, must be wrapped in parentheses, e.g. `(parser)`")]
    InvalidScope(String),

    #[error(
        "scope is required by configuration, please provide one in parentheses, e.g. `feat(parser): xxx`"
    )]
    EmptyScope,

    #[error(
        "allowed_scopes is empty, If you don't need scope validation, remove or comment out the entire allowed_scopes field instead."
    )]
    EmptyAllowedScopes,

    #[error(
        "parentheses detected but scope is empty: `{left}`\nIf scope is not needed, remove the parentheses; otherwise, provide content, e.g. `feat(parser): xxx`"
    )]
    EmptyScopeWithParen { left: String },

    #[error("scope `{scope}` is not in the allowed list, allowed scopes are {allowed_scopes:?}")]
    NotAllowedScope {
        scope: String,
        allowed_scopes: Vec<String>,
    },

    // Subject validation module
    #[error("full-width space after colon is not allowed (use half-width space ' ')")]
    FullWidthSpaceNotAllowed,

    #[error(
        "number of spaces after colon does not match, expected {expected}, found {actual}. Please add space after colon, e.g. `feat: xxx`"
    )]
    SpaceAfterColonNotMatch { expected: usize, actual: usize },

    #[error("subject ends with a period, periods are not allowed. Please remove the period")]
    SubjectEndsWithPeriod,

    #[error(
        "subject length must be between {min} and {max} characters, current length is {actual}"
    )]
    InvalidSubjectLength {
        min: usize,
        max: usize,
        actual: usize,
    },

    #[error("subject cannot be empty, please provide commit description after colon")]
    EmptySubject,

    #[error(
        "breaking marker `!` must be placed after type or scope, before colon, e.g. `feat!: xxx`"
    )]
    InvalidBreakingPosition,

    #[error("regex group `spaces` not found")]
    MissingSpacesGroup,
}