is_valid

Whether message is a valid Conventional Commit.

A shortcut for Commit::parse(message).is_ok(), for a commit-msg hook or a CI check that only needs a yes or no; use Commit::parse to learn what is wrong.

Import

use helpers4::commit::is_valid;

Cargo feature commit (enabled by default). To compile only this module:

cargo add helpers4 --no-default-features --features commit

or in Cargo.toml:

[dependencies]
helpers4 = { version = "0.0.6", default-features = false, features = ["commit"] }

Signature

pub fn is_valid(message: &str) -> bool

Parameters

Parameter	Type	Description
message	&str	The whole commit message.

Returns

bool — true when the message parses.

Examples

use helpers4::commit::is_valid;

assert!(is_valid("fix(parser): handle empty input"));
assert!(!is_valid("fixed some stuff"));

Source

src/commit/is_valid.rs