Struct Definition 

pub struct Definition {
    pub types: Option<Vec<String>>,
    pub thresholds: Option<Thresholds>,
}

Configuration for a commit-message check.

Both fields are optional. When omitted, defaults apply: standard Conventional Commits types and { fail: 0 }.

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

let def = Definition {
    types: Some(vec!["hotfix".into()]),
    thresholds: Some(Thresholds { warn: None, fail: Some(0) }),
};

let evals = commit_message::check("hotfix: urgent patch", &def).unwrap();
assert!(evals[0].is_pass());

let evals = commit_message::check("feat: add login", &def).unwrap();
assert!(evals[0].is_fail());

Fields

types: Option<Vec<String>>

thresholds: Option<Thresholds>

Trait Implementations

impl Debug for Definition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Definition

fn default() -> Definition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Definition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.