Struct git_checks::checks::Formatting

pub struct Formatting { /* private fields */ }

Run a formatter in the repository to check commits for formatting.

The formatter is passed a single argument: the path to the file which should be checked.

The formatter is expected to exit with success whether the path passed to it has a valid format in it or not. A failure exit status is considered a failure of the formatter itself. If any changes (including untracked files) are left inside of the worktree, it is considered to have failed the checks.

The formatter is run with its current working directory being the top-level of the work tree, but not the proper GIT_ context. This is because the setup for the workarea is not completely isolated and git commands may not behave as expected. The worktree it is working from is only guaranteed to have the files which have changed in the commit being checked on disk, so additional files which should be available for the command to run must be specified with Formatting::add_config_files.

Implementations

impl Formatting

pub fn new<K, F>(kind: K, formatter: F) -> Selfwhere
    K: ToString,
    F: AsRef<Path>,

Create a new formatting check.

pub fn named<N>(&mut self, name: N) -> &mut Selfwhere
    N: ToString,

Set the name of the formatter.

pub fn add_config_files<I, F>(&mut self, files: I) -> &mut Selfwhere
    I: IntoIterator<Item = F>,
    F: ToString,

Add configuration files within the repository which should be checked out.

pub fn with_fix_message<F>(&mut self, fix_message: F) -> &mut Selfwhere
    F: ToString,

Add a message for how to fix issues with this formatter.

pub fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Add a timeout to the formatter.

Trait Implementations

impl Clone for Formatting

fn clone(&self) -> Formatting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContentCheck for Formatting

fn name(&self) -> &str

The name of the check.

fn check(
    &self,
    ctx: &CheckGitContext,
    content: &dyn Content
) -> Result<CheckResult>

Run the check.

impl Debug for Formatting

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

Formats the value using the given formatter.