Struct CommitSubject

pub struct CommitSubject { /* private fields */ }

Check commit message subjects for invalid patterns.

Patterns which are checked for:

• overly long or short summary lines;
• work-in-progress messages;
• fixup!, squash!, and amend! messages; and
• custom prefixes.

Commit messages which appear to have been auto generated by actions such as merging or reverting commits will skip the summary line length limit (if enforced).

Implementations

impl CommitSubject

pub fn builder() -> CommitSubjectBuilder

Create a new builder.

Trait Implementations

impl Check for CommitSubject

fn name(&self) -> &str

The name of the check.

fn check( &self, _: &CheckGitContext, commit: &Commit, ) -> Result<CheckResult, Box<dyn Error>>

Run the check.

impl Clone for CommitSubject

fn clone(&self) -> CommitSubject

Returns a copy 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() -> Self

Returns the “default value” for a type.