Struct Formatting 

pub struct Formatting { /* private fields */ }

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

The formatter is passed the following arguments:

• the path to the file which should be checked.
• if provided, the value of the controlling attribute.

At runtime, the following configuration keys may be used to amend the check’s behavior:

• formatter.{kind}.path: the path to the formatter executable
• formatter.env_key: an environment variable to set to the value check so that the formatter knows it is being run for a check.

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 builder() -> FormattingBuilder

Create a new builder.

Trait Implementations

impl Clone for Formatting

fn clone(&self) -> Formatting

Returns a duplicate 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, Box<dyn Error>>

Run the check.

impl Debug for Formatting

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

Formats the value using the given formatter.