Skip to main content

check

Function check 

Source
pub fn check(
    message: &str,
    definition: &Definition,
) -> Result<Vec<Evaluation>, ExecutionError>
Expand description

Validate a commit message against the Conventional Commits spec.

Git comment lines (#-prefixed) are stripped before validation. Use Definition::default() for standard Conventional Commits types and { fail: 0 }.

ยงErrors

Always returns Ok. Validation issues appear as evidence in the evaluation, not as errors.

use scute_core::commit_message;
use scute_core::commit_message::Definition;

let evals = commit_message::check("feat(auth): add OAuth flow", &Definition::default()).unwrap();
assert!(evals[0].is_pass());

let evals = commit_message::check("banana: ", &Definition::default()).unwrap();
assert!(evals[0].is_fail());