conventional

Crates.ioconventional
lib.rsconventional
version0.5.0
sourcesrc
created_at2019-08-15 19:49:06.31995
updated_at2019-11-22 16:20:33.104372
descriptionA parser library for the Conventional Commit specification.
homepage
repositoryhttps://github.com/rustic-games/conventional-commit
max_upload_size
id157152
size37,681
Ed Page (epage)

documentation

README

conventional::Commit

Latest Crate Version Library Documentation Discord Chat


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 conventional
    
  2. 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());
    
  3. 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_());
    
  4. Check out tools like Jilu for an example of library usage.

Commit count: 47

cargo fmt