Skip to content

crate-ci/git-conventional

Repository files navigation

code>conventional::Commit

codecov Documentation License Crates Status

A Rust parser library for the Conventional Commit spec.

Quick Start

  1. Add the crate to your Cargo.toml:
$ cargo add git_conventional
  1. 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::Type::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

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.