Struct git_checks::config::FormattingConfig
source · pub struct FormattingConfig { /* private fields */ }
Expand description
Configuration for the Formatting
check.
The kind
key is required and is a string. This is used to construct the name of the Git
attribute to look for to find files which are handled by this formatter. The name
key is
optional, but is a string and defaults to the given kind
. The formatter
key is a string
containing the path to the formatter on the system running the checks. Some formatters may
work with configuration files committed to the repository. These will also be checked out
when using this formatter. These may be valid Git path specifications with globs. If
problems are found, the optional fix_message
key (a string) will be added to the message.
This should describe how to fix the issues found by the formatter. The timeout
key is an
optional positive integer. If given, formatters not completing within the specified time
are considered failures. Without a timeout, formatters which do not exit will cause the
formatting check to wait forever.
This check is registered as a commit check with the name "formatting"
and a topic check
with the name "formatting/topic"
.
Example
{
"name": "formatter name",
"kind": "kind",
"formatter": "/path/to/formatter",
"config_files": [
"path/to/config/file"
],
"fix_message": "instructions for fixing",
"timeout": 10,
}