README.md

code>conventional::Commit

A Rust parser library for the Conventional Commit spec.

Quick Start

1. Add the crate to your Cargo.toml:

   cargo install cargo-edit
   
   cargo add git_conventional

2. Parse a commit and lookup what you need

   let commit = git_conventional::Commit::parse("feat(conventional commit): this is it!").unwrap();
   
   assert_eq!(commit.type_(), git_conventional::FEAT);
   assert_eq!(commit.scope().unwrap(), "conventional commit");
   assert_eq!(commit.description(), "this is it!");
   assert_eq!(commit.body(), None);

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.