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

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

#37 in #conventional-commits

Download history 1276/week @ 2025-03-30 992/week @ 2025-04-06 970/week @ 2025-04-13 1245/week @ 2025-04-20 1146/week @ 2025-04-27 1004/week @ 2025-05-04 1256/week @ 2025-05-11 1061/week @ 2025-05-18 1119/week @ 2025-05-25 1059/week @ 2025-06-01 1011/week @ 2025-06-08 843/week @ 2025-06-15 1007/week @ 2025-06-22 1036/week @ 2025-06-29 1062/week @ 2025-07-06 936/week @ 2025-07-13

4,059 downloads per month
Used in 6 crates

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.7MB
~55K SLoC