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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
use crate::config::commit_msg_rule::ParsedCommitMsgRule;
use crate::error::body_error::BodyError;
use crate::error::body_error::BodyError::{BodyLineLengthInvalid, EmptyBody, TrailingWhitespace};
use crate::error::commit_msg_error::CommitMsgError;
use crate::error::footer_error::FooterError;
use crate::error::footer_error::FooterError::{
    FooterKeywordTypoError, FooterLineLengthInvalid, FooterStartKeywordInvalid,
    FooterTrailingWhitespace,
};
use crate::error::header_error::HeaderError::{
    EmptyAllowedScopes, EmptyAllowedTypes, EmptyScope, EmptySubject, InvalidSubjectLength,
    NotAllowedScope, NotAllowedType, SpaceAfterColonNotMatch, SubjectEndsWithPeriod, TypeTypo,
};
use crate::parser::commit_msg::ParsedCommitMessage;
use crate::parser::header::ParsedHeader;
use strsim::normalized_levenshtein;

pub fn validate_commit_msg(
    parsed_commit_msg: &ParsedCommitMessage,
    parsed_commit_msg_rule: &ParsedCommitMsgRule,
) -> Result<bool, CommitMsgError> {
    let header = &parsed_commit_msg.header;

    // 1. validate type
    validate_type(header, parsed_commit_msg_rule)?;

    // 2. validate scope
    validate_scope(header, parsed_commit_msg_rule)?;

    // 3. validate subject
    validate_subject(header, parsed_commit_msg_rule)?;

    // 4. validate body
    validate_body(parsed_commit_msg, parsed_commit_msg_rule)?;

    // 5. validate footer
    validate_footer(parsed_commit_msg, parsed_commit_msg_rule)?;
    Ok(true)
}

fn validate_type(header: &ParsedHeader, rule: &ParsedCommitMsgRule) -> Result<(), CommitMsgError> {
    if let Some(allowed) = &rule.header.r#type.allowed_types {
        if allowed.is_empty() {
            return Err(CommitMsgError::Header(EmptyAllowedTypes));
        }

        if !allowed.contains(&header.r#type) {
            let threshold = 0.8;

            if let Some((correct, similarity)) =
                detect_type_typo(&header.r#type, allowed, threshold)
            {
                return Err(CommitMsgError::Header(TypeTypo {
                    wrong: header.r#type.clone(),
                    correct,
                    similarity,
                    allowed_types: allowed.clone(),
                }));
            }

            return Err(CommitMsgError::Header(NotAllowedType {
                r#type: header.r#type.clone(),
                allowed_types: allowed.clone(),
            }));
        }
    }

    Ok(())
}

pub fn detect_type_typo(wrong: &str, allowed: &[String], threshold: f64) -> Option<(String, f64)> {
    let mut best = None;
    let mut best_score = 0.0;

    for valid in allowed {
        let score = normalized_levenshtein(wrong, valid);
        if score > best_score {
            best_score = score;
            best = Some(valid.clone());
        }
    }

    if best_score >= threshold {
        best.map(|b| (b, best_score))
    } else {
        None
    }
}

fn validate_scope(header: &ParsedHeader, rule: &ParsedCommitMsgRule) -> Result<(), CommitMsgError> {
    let Some(scope_cfg) = &rule.header.scope else {
        return Ok(()); // no scope rule → pass
    };

    let scope = header.scope.as_ref();
    let allowed = scope_cfg.allowed_scopes.as_ref();

    // --- Case 1: scope is required ---
    if scope_cfg.required == Some(true) {
        // 1.1 required but missing
        let Some(scope_value) = scope else {
            return Err(CommitMsgError::Header(EmptyScope));
        };

        // 1.2 required but allowed_scopes is empty or missing
        let Some(allowed_scopes) = allowed else {
            return Err(CommitMsgError::Header(EmptyAllowedScopes));
        };
        if allowed_scopes.is_empty() {
            return Err(CommitMsgError::Header(EmptyAllowedScopes));
        }

        // 1.3 required + provided + allowed_scopes exists → check membership
        if !allowed_scopes.contains(scope_value) {
            return Err(CommitMsgError::Header(NotAllowedScope {
                scope: scope_value.clone(),
                allowed_scopes: allowed_scopes.clone(),
            }));
        }

        return Ok(());
    }

    // --- Case 2: scope is optional ---
    // 2.1 optional and not provided → OK
    let Some(scope_value) = scope else {
        return Ok(());
    };

    // 2.2 optional + provided but no allowed_scopes → OK
    let Some(allowed_scopes) = allowed else {
        return Ok(());
    };

    // 2.3 optional + provided + allowed_scopes empty → error
    if allowed_scopes.is_empty() {
        return Err(CommitMsgError::Header(EmptyAllowedScopes));
    }

    // 2.4 optional + provided + allowed_scopes exists → check membership
    if !allowed_scopes.contains(scope_value) {
        return Err(CommitMsgError::Header(NotAllowedScope {
            scope: scope_value.clone(),
            allowed_scopes: allowed_scopes.clone(),
        }));
    }

    Ok(())
}

fn validate_subject(
    header: &ParsedHeader,
    rule: &ParsedCommitMsgRule,
) -> Result<(), CommitMsgError> {
    let subject_cfg = &rule.header.subject;
    let subject = &header.subject;

    //  validate subject is not empty
    if subject.is_empty() {
        return Err(CommitMsgError::Header(EmptySubject));
    }

    // validate subject leading spaces
    let expected_spaces = subject_cfg.spaces_after_colon.unwrap_or(1);

    if header.spaces_after_colon != expected_spaces {
        return Err(CommitMsgError::Header(SpaceAfterColonNotMatch {
            expected: expected_spaces,
            actual: header.spaces_after_colon,
        }));
    }

    // validate subject does not end with period
    if rule.header.subject.forbid_trailing_period
        && (subject.ends_with('.') || subject.ends_with(''))
    {
        return Err(CommitMsgError::Header(SubjectEndsWithPeriod));
    }

    // validate subject length
    let subject_len = subject.chars().count();
    if subject_len < subject_cfg.min_length || subject_len > subject_cfg.max_length {
        return Err(CommitMsgError::Header(InvalidSubjectLength {
            min: subject_cfg.min_length,
            max: subject_cfg.max_length,
            actual: subject_len,
        }));
    }

    Ok(())
}

pub fn validate_body(
    parsed: &ParsedCommitMessage,
    rule: &ParsedCommitMsgRule,
) -> Result<(), CommitMsgError> {
    let Some(body_rule) = &rule.body else {
        return Ok(());
    };

    // validate body is not empty
    if body_rule.required && parsed.body.is_none() {
        return Err(CommitMsgError::Body(EmptyBody));
    }

    // body is empty and not required → pass
    let Some(body) = parsed.body.as_deref() else {
        return Ok(());
    };

    // validate blank lines before body
    if parsed.blank_lines_before_body < body_rule.min_blank_lines_before_body {
        return Err(CommitMsgError::Body(
            BodyError::BlankLinesBeforeBodyNotEnough {
                min_line: body_rule.min_blank_lines_before_body,
                current_line: parsed.blank_lines_before_body,
            },
        ));
    }

    // validate trailing whitespace
    if body_rule.forbid_trailing_whitespace {
        for (i, line) in body.lines().enumerate() {
            if line.ends_with(' ') {
                return Err(CommitMsgError::Body(TrailingWhitespace {
                    line_number: i + 1,
                }));
            }
        }
    }

    // validate line length
    for (i, line) in body.lines().enumerate() {
        let trimmed = line.trim();

        //  Allow empty lines
        if trimmed.is_empty() {
            continue;
        }

        // 3. Only validate actual body content lines
        let len = trimmed.chars().count();
        if len < body_rule.min_line_length || len > body_rule.max_line_length {
            return Err(CommitMsgError::Body(BodyLineLengthInvalid {
                line_number: i + 1,
                min: body_rule.min_line_length,
                max: body_rule.max_line_length,
                actual: len,
            }));
        }
    }

    Ok(())
}

pub fn validate_footer(
    parsed: &ParsedCommitMessage,
    rule: &ParsedCommitMsgRule,
) -> Result<(), CommitMsgError> {
    let Some(footer_rule) = &rule.footer else {
        return Ok(()); // no footer rule → pass
    };

    // footer is empty and not required → pass
    let Some(_footer) = parsed.footer.as_deref() else {
        return Ok(());
    };

    // validate blank lines before footer
    if parsed.blank_lines_before_footer < footer_rule.min_blank_lines_before_footer {
        return Err(CommitMsgError::Footer(
            FooterError::BlankLinesBeforeFooterNotEnough {
                min_line: footer_rule.min_blank_lines_before_footer,
                current_line: parsed.blank_lines_before_footer,
            },
        ));
    }

    // validate footer start keyword
    // --- Smart footer keyword validation (supports typo detection) ---
    if !footer_rule.start_key_words.is_empty() {
        let footer_text = parsed.footer.as_deref().ok_or(FooterError::MissingFooter)?;

        let first_line = footer_text.lines().next().unwrap_or("").trim();

        // Extract keyword before colon
        let (keyword, _) = match first_line.split_once(':') {
            Some(v) => v,
            None => {
                return Err(CommitMsgError::Footer(FooterStartKeywordInvalid {
                    allowed: footer_rule.start_key_words.clone(),
                    actual: first_line.to_string(),
                }));
            }
        };

        let keyword = keyword.trim();

        // Load spellcheck config
        #[allow(clippy::expect_used)]
        let spell_cfg = footer_rule
            .start_key_words_spellcheck
            .as_ref()
            .expect("start_key_words_spellcheck must exist when start_key_words is non-empty");
        let threshold = spell_cfg.threshold;

        // Find best match by similarity
        let best_match = footer_rule
            .start_key_words
            .iter()
            .map(|k| (k, strsim::normalized_levenshtein(keyword, k)))
            .max_by(|a, b| a.1.total_cmp(&b.1));

        if let Some((correct, similarity)) = best_match {
            if similarity < threshold {
                // Similarity is too low → treat as not a footer
                return Err(CommitMsgError::Footer(FooterStartKeywordInvalid {
                    actual: keyword.to_string(),
                    allowed: footer_rule.start_key_words.clone(),
                }));
            }

            if similarity < 1.0 {
                // Similarity is high enough but not a perfect match → spelling error
                return Err(CommitMsgError::Footer(FooterKeywordTypoError {
                    wrong: keyword.to_string(),
                    correct: correct.clone(),
                    similarity,
                    threshold,
                }));
            }

            // similarity == 1.0 → completely correct
        }
    }

    if let Some(footer) = &parsed.footer {
        for (i, line) in footer.lines().enumerate() {
            let width = line.chars().count();

            if width < footer_rule.min_line_length || width > footer_rule.max_line_length {
                return Err(CommitMsgError::Footer(FooterLineLengthInvalid {
                    line_number: i + 1,
                    min: footer_rule.min_line_length,
                    max: footer_rule.max_line_length,
                    actual: width,
                }));
            }
        }
    }

    // validate footer trailing whitespace
    if footer_rule.forbid_trailing_whitespace
        && let Some(footer) = &parsed.footer
    {
        for (i, line) in footer.lines().enumerate() {
            if line.ends_with(' ') {
                return Err(CommitMsgError::Footer(FooterTrailingWhitespace {
                    line_number: i + 1,
                }));
            }
        }
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config;
    use crate::constant::COMMIT_MSG_RULE_TEMPLATE;
    use crate::parser::commit_msg::parse_commit_msg;

    #[test]
    fn test_validate_commit_msg() {
        let commit_msg = r#"feat: add new feature"#;
        let parsed_commit_msg = parse_commit_msg(commit_msg);
        let parsed_commit_msg_rule =
            config::commit_msg_rule::parse_commit_msg_rule(COMMIT_MSG_RULE_TEMPLATE);

        let is_valid = validate_commit_msg(
            parsed_commit_msg.as_ref().unwrap(),
            &parsed_commit_msg_rule.unwrap(),
        );
        println!("is_valid: {:?}", is_valid);
        assert!(is_valid.is_ok());
    }

    #[test]
    fn test_type_typo() {
        let commit_msg = r#"feats: add new feature"#;
        let parsed_commit_msg = parse_commit_msg(commit_msg);
        let parsed_commit_msg_rule =
            config::commit_msg_rule::parse_commit_msg_rule(COMMIT_MSG_RULE_TEMPLATE);

        let is_valid = validate_commit_msg(
            parsed_commit_msg.as_ref().unwrap(),
            &parsed_commit_msg_rule.unwrap(),
        );

        assert!(is_valid.as_ref().is_err());

        match is_valid.as_ref().unwrap_err() {
            CommitMsgError::Header(TypeTypo {
                wrong,
                correct,
                similarity,
                allowed_types: _,
            }) => {
                assert_eq!(*correct, "feat".to_string());
                assert!(*similarity > 0.7);
                assert_eq!(*wrong, "feats".to_string());
            }

            _ => {
                panic!("unexpected error: {:?}", is_valid);
            }
        }
    }

    #[test]
    fn test_valid_body_and_footer() {
        let msg = "\
feat: add new API


This is body line 1
This is body line 2

BREAKING CHANGE: API changed
";

        let parsed = parse_commit_msg(msg);

        // assert_eq!(parsed.as_ref().unwrap().blank_lines_before_body, 2);
        // assert_eq!(parsed.as_ref().unwrap().blank_lines_before_footer, 1);
        println!("{:#?}", parsed);
    }
}