Name		Name	Last commit message	Last commit date
src		src
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
Cargo.toml		Cargo.toml
README.md		README.md
rustfmt.toml		rustfmt.toml

Repository files navigation

README

conventional::Commit

A Rust parser library for the Conventional Commit spec.

Quick Start

Add the crate to your Cargo.toml:

cargo install cargo-edit

cargo add conventional

Import the Commit type and the Simple trait to parse a commit string, and query its different components as string slices:

use conventional::{Commit, Simple as _};

let commit = Commit::new("feat(conventional commit): this is it!").unwrap();

assert_eq!("feat", commit.type_());
assert_eq!("conventional commit", commit.scope());
assert_eq!("this is it!", commit.description());
assert_eq!(None, commit.body());

Upgrade to Typed components for strongly typed access:

use conventional::{Commit, Typed as _};

let commit = Commit::new("feat(conventional commit): this is it!").unwrap();

assert_eq!(Type("feat"), commit.type_());