Struct git_checks::checks::CommitSubject

pub struct CommitSubject { /* fields omitted */ }

Check commit message subjects for invalid patterns.

Methods

impl CommitSubject

pub fn new() -> Self

Checks commit message subjects for invalid patterns

Patterns which are checked for:

• overly long or short summary lines;
• work-in-progress messages;
• fixup! and squash! 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).

pub fn with_summary_limits(&mut self, min: usize, max: usize) -> &mut Self

Check the summary line with the given limits.

pub fn check_work_in_progress(&mut self, wip: bool) -> &mut Self

Checks for work-in-progress commits

Commit messages which mention WIP or wip at the beginning of their commit messages are rejected since they are (nominally) incomplete.

pub fn check_rebase_commands(&mut self, rebase: bool) -> &mut Self

Check for rebase commands

Rebase commands include commits which begin with fixup! or squash! . These subjects are used to indicate that the commit belongs somewhere else in the branch and should be completed before merging.

pub fn with_tolerated_prefixes<I, P>(&mut self, patterns: I) -> &mut Self where
    I: IntoIterator<Item = P>,
    P: Into<Regex>, 

Check for tolerated commit subject prefixes.

The specified prefix patterns will be tolerated regardless of any configured allowed or disallowed prefixes.

pub fn with_allowed_prefixes<I, P>(&mut self, prefixes: I) -> &mut Self where
    I: IntoIterator<Item = P>,
    P: Into<String>, 

Check for required commit prefixes.

The specified prefixes will be the only allowed prefixes on commit message subjects that do not match a tolerated pattern.

pub fn with_disallowed_prefixes<I, P>(&mut self, prefixes: I) -> &mut Self where
    I: IntoIterator<Item = P>,
    P: Into<String>, 

Check for disallowed commit prefixes.

The specified prefixes will be rejected on commit message subjects that do not also match a tolerated pattern.

Trait Implementations

impl Check for CommitSubject

fn name(&self) -> &str

The name of the check.

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

Run the check.

impl Default for CommitSubject

fn default() -> CommitSubject

Returns the "default value" for a type.

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.