#conventional-commits #commit-message #message-parser #specification #git

conventional_commit_parser

A rust implementation of the conventional commit specification

13 releases (6 breaking)

0.9.4 Jan 17, 2022
0.9.3 Nov 21, 2021
0.8.0 Nov 1, 2021

#2742 in Parser implementations

Download history 2059/week @ 2024-07-19 4938/week @ 2024-07-26 3273/week @ 2024-08-02 2116/week @ 2024-08-09 2378/week @ 2024-08-16 3918/week @ 2024-08-23 3633/week @ 2024-08-30 2353/week @ 2024-09-06 4126/week @ 2024-09-13 4904/week @ 2024-09-20 4338/week @ 2024-09-27 3426/week @ 2024-10-04 3516/week @ 2024-10-11 3489/week @ 2024-10-18 2792/week @ 2024-10-25 2050/week @ 2024-11-01

12,209 downloads per month
Used in 15 crates (6 directly)

Custom license

27KB
495 lines

Conventional commit parser

Latest Version Conventional Commits License

A rust implementation of the conventional commit specification.

Example

use conventional_commit_parser::parse;
use conventional_commit_parser::commit::*;
let message = r#"fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z
Refs #133"#;

let conventional_commit = parse(message)?;

assert_eq!(conventional_commit.commit_type, CommitType::BugFix);
assert_eq!(conventional_commit.summary, "correct minor typos in code".to_string());
assert_eq!(conventional_commit.body, Some(r#"see the issue for details

on typos fixed."#.to_string()));

assert_eq!(conventional_commit.footers, vec![
    Footer {token: "Reviewed-by".to_string(), content: "Z".to_string()},
    Footer {token: "Refs".to_string(), content: "133".to_string(),}
]);

Licence

All the code in this repository is released under the MIT License, for more information take a look at the LICENSE file.

Dependencies

~2–2.8MB
~57K SLoC