Enum CommitRule 

pub enum CommitRule {
    NotConventional,
    SubjectTooLong,
    SubjectEmpty,
    SubjectTrailingPeriod,
    UnknownScope,
    FixWithoutTest,
    UnresolvedReference,
    BreakingUnexplained,
}

Every code this module can produce, as one closed set.

A judgement is a value here and not a string at the call site. The codes reach a person through a diagnostic, a machine through JSON and a hook through an exit code, and all three read the same list — which is what makes a finding something a rule document can name and a test can assert on.

use majordomus_cli::commit::CommitRule;
// every rule has a stable code, and the order is the order a person would fix them in
assert_eq!(CommitRule::NotConventional.code(), "commit.not_conventional");
assert_eq!(CommitRule::ALL.first(), Some(&CommitRule::NotConventional));
assert!(CommitRule::ALL.iter().all(|r| r.code().starts_with("commit.")));

Variants

NotConventional

The header is not type(scope): subject.

SubjectTooLong

The subject is wider than the policy allows.

SubjectEmpty

The header parsed but said nothing after the colon.

SubjectTrailingPeriod

The subject ends in a full stop; a subject is a title, not a sentence.

UnknownScope

The scope is not one this repository’s history or layout yields.

FixWithoutTest

A fix whose staged files include no test.

UnresolvedReference

The message names a record id the layer does not hold.

BreakingUnexplained

The commit declares itself breaking and explains nothing.

Implementations

impl CommitRule

pub const ALL: &'static [CommitRule]

Every rule, in the order a verdict reports them. Ordered by how early in the message the evidence for them appears, so a person reads findings in the order they would fix them.

pub fn code(self) -> &'static str

The stable code a diagnostic carries.

use majordomus_cli::commit::CommitRule;
assert_eq!(CommitRule::SubjectTooLong.code(), "commit.subject_too_long");

Trait Implementations

impl Clone for CommitRule

fn clone(&self) -> CommitRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CommitRule

impl Debug for CommitRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommitRule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommitRule

impl JsonSchema for CommitRule

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CommitRule

fn eq(&self, other: &CommitRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CommitRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommitRule