Struct git_checks::checks::Formatting
[−]
[src]
pub struct Formatting { /* fields omitted */ }
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
.
Methods
impl Formatting
[src]
fn new<K, F>(kind: K, formatter: F) -> Self where
K: ToString,
F: AsRef<Path>,
[src]
K: ToString,
F: AsRef<Path>,
Create a new formatting check.
fn named<N>(&mut self, name: N) -> &mut Self where
N: ToString,
[src]
N: ToString,
Set the name of the formatter.
fn add_config_files<I, F>(&mut self, files: I) -> &mut Self where
I: IntoIterator<Item = F>,
F: ToString,
[src]
I: IntoIterator<Item = F>,
F: ToString,
Add configuration files within the repository which should be checked out.
fn with_fix_message<F>(&mut self, fix_message: F) -> &mut Self where
F: ToString,
[src]
F: ToString,
Add a message for how to fix issues with this formatter.
fn with_timeout(&mut self, timeout: Duration) -> &mut Self
[src]
Add a timeout to the formatter.
Trait Implementations
impl Debug for Formatting
[src]
impl Clone for Formatting
[src]
fn clone(&self) -> Formatting
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl ContentCheck for Formatting
[src]
fn name(&self) -> &str
[src]
The name of the check.
fn check(&self, ctx: &CheckGitContext, content: &Content) -> Result<CheckResult>
[src]
Run the check.