#conventional-commits #commit-message #parser #message-parser #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

#1967 in Parser implementations

Download history 1116/week @ 2023-11-20 2091/week @ 2023-11-27 3190/week @ 2023-12-04 1952/week @ 2023-12-11 2283/week @ 2023-12-18 2494/week @ 2023-12-25 1940/week @ 2024-01-01 1493/week @ 2024-01-08 2229/week @ 2024-01-15 2534/week @ 2024-01-22 1417/week @ 2024-01-29 1869/week @ 2024-02-05 2922/week @ 2024-02-12 3310/week @ 2024-02-19 3120/week @ 2024-02-26 3105/week @ 2024-03-04

12,590 downloads per month
Used in 12 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

~3MB
~59K SLoC