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; and
• fixup! and squash! messages.

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).

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Check the summary line with the given limits.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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.

Trait Implementations

impl Debug for CommitSubject

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

Formats the value using the given formatter.

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 Copy for CommitSubject

impl Check for CommitSubject

fn name(&self) -> &str

The name of the check.

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

Run the check.