Struct CommitPolicy 

pub struct CommitPolicy {
    pub subject_max_chars: usize,
    pub scope_unknown: FindingLevel,
    pub fix_requires_test: FindingLevel,
    pub reference_unresolved: FindingLevel,
    pub breaking_unexplained: FindingLevel,
}

commit: in the repository policy: the subject width, and how loudly to report the four judgements a repository can reasonably decide differently about. The type vocabulary is deliberately absent — it is crate::release::ChangeKind, which the changelog already renders from, and a second copy of those words here is the duplication this subsystem exists to remove.

use majordomus_cli::commit::{CommitPolicy, FindingLevel};
// a policy that says nothing is the default this repository's history already satisfies
let quiet: CommitPolicy = serde_json::from_str("{}").expect("an empty block");
assert_eq!(quiet, CommitPolicy::default());
assert_eq!(quiet.subject_max_chars, 72);
// and one that says something keeps the defaults it did not mention
let narrow: CommitPolicy =
    serde_json::from_str(r#"{"subject_max_chars": 50}"#).expect("a block");
assert_eq!(narrow.subject_max_chars, 50);
assert_eq!(narrow.reference_unresolved, FindingLevel::Error);

Fields

subject_max_chars: usize

The widest a subject line may be. 72 is what a terminal and every git viewer show without wrapping, and what this repository’s history already keeps to.

scope_unknown: FindingLevel

A scope outside the vocabulary the repository’s own history and layout yield. A warning by default: the vocabulary is inferred, and inference must not refuse the first commit of a new subsystem.

fix_requires_test: FindingLevel

A fix whose staged files include no test. The strongest available evidence that a bug fix carries a regression test, and the cheapest place to ask for it.

reference_unresolved: FindingLevel

A record id in the message — I1305, M000 — that the layer does not hold. An error by default: a reference to a record that does not exist cannot be told from a good one until somebody follows it, which is usually months later.

breaking_unexplained: FindingLevel

A commit that declares itself breaking and says nothing else. An error by default: the ! is the only mark a release reads, and a release note derived from a breaking change with no explanation is a release note that says a thing broke.

Trait Implementations

impl Clone for CommitPolicy

fn clone(&self) -> CommitPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitPolicy

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

Formats the value using the given formatter.

impl Default for CommitPolicy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommitPolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommitPolicy

impl JsonSchema for CommitPolicy

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 CommitPolicy

fn eq(&self, other: &CommitPolicy) -> 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 CommitPolicy

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 CommitPolicy