Struct CommitGroup 

pub struct CommitGroup {
    pub message: CommitMessage,
    pub paths: Vec<String>,
    pub rationale: String,
    pub scope_from: Option<ScopeSuggestion>,
}

One commit a plan proposes. One commit a plan proposes: its message, its paths, and why those paths are one commit.

use majordomus_cli::commit::{plan::group, CommitGroup, ScopeVocabulary};
let mut v = ScopeVocabulary::default();
v.learn("commit", "src/commit", 40);
let g: Vec<CommitGroup> = group(&["src/commit/a.rs".into()], &v, &[]);
// the subject is empty on purpose: what a change did is the one thing no evidence in
// the tree can state
assert_eq!(g[0].message.header.subject, "");
assert_eq!(g[0].message.header.scope.as_deref(), Some("commit"));
assert!(g[0].rationale.contains("40 prior commit"), "{}", g[0].rationale);

Fields

message: CommitMessage

The message as proposed. The summary is the one field a person is expected to replace: nothing here can know why a change was made, and a planner that wrote a confident sentence about it would be writing fiction into the history.

paths: Vec<String>

The paths, in order.

rationale: String

Why these paths are one commit, in evidence a reader can check.

scope_from: Option<ScopeSuggestion>

The scope suggestion and what it was derived from, when there was one.

Trait Implementations

impl Clone for CommitGroup

fn clone(&self) -> CommitGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommitGroup

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommitGroup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommitGroup

impl JsonSchema for CommitGroup

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 CommitGroup

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

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 CommitGroup