Struct CommitSubject 

pub struct CommitSubject {
    pub text: String,
    pub scopes: Option<Vec<String>>,
    pub paths: Option<Vec<String>>,
    pub records: Vec<String>,
}

Everything the judge is allowed to look at.

A struct rather than five arguments, because the two halves that are optional are exactly the two a caller may not have: a hook running on commit-msg knows the staged files, a gate reading history does not, and a judge that demanded both would have to be two judges.

use majordomus_cli::commit::{judge, CommitPolicy, CommitSubject};
// the two optional halves are the two a caller may not have: a hook knows the staged
// files, a gate reading history does not
let hook = CommitSubject {
    text: "fix(a): a thing".into(),
    paths: Some(vec!["src/a.rs".into()]),
    ..CommitSubject::default()
};
assert_eq!(judge(&hook, &CommitPolicy::default()).findings.len(), 1);
let gate = CommitSubject::of("fix(a): a thing");
assert!(judge(&gate, &CommitPolicy::default()).findings.is_empty());

Fields

text: String

The message as it will be stored.

scopes: Option<Vec<String>>

The scope vocabulary this repository yields, when it has been derived.

paths: Option<Vec<String>>

The paths this commit will contain, when they are known.

records: Vec<String>

The record ids the layer holds, for resolving what the message names.

Implementations

impl CommitSubject

pub fn of(text: &str) -> CommitSubject

A subject that is only a message: the judgements that need no other evidence.

use majordomus_cli::commit::CommitSubject;
let s = CommitSubject::of("feat(a): a thing");
assert!(s.paths.is_none(), "a judgement needing paths is not made rather than guessed");
assert!(s.scopes.is_none());

Trait Implementations

impl Clone for CommitSubject

fn clone(&self) -> CommitSubject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommitSubject

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

Formats the value using the given formatter.

impl Default for CommitSubject

fn default() -> CommitSubject

Returns the “default value” for a type.