.pre-commit-hooks.yml
pre-commit hooks definition file
| Type | object[] |
|---|---|
| File match |
.pre-commit-hooks.yml
.pre-commit-hooks.yaml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/pre-commit-hooks-yml/latest.json |
| Source | https://www.schemastore.org/pre-commit-hooks.json |
Validate with Lintel
npx @lintel/lintel check
Items
id of the hook - used in pre-commit-config.yaml.
name of the hook - shown during hook execution.
entry point - the executable to run. Can also contain arguments that will not be overridden such as entry: autopep8 -i.
(optional) allows the hook to be referenced using an additional id.
(optional) the pattern of files to run on.
(optional) exclude files that were matched by files.
(optional) a list of dependencies that will be installed in the environment where this hook gets run. One useful application is to install plugins for hooks such as eslint.
(optional) if true this hook will run even if there are no matching files.
(optional) if true this hook will run even if there are no matching files.
(optional) if true, forces the output of the hook to be printed even when the hook passes.
(optional) if false no filenames will be passed to the hook.
(optional) if true this hook will execute using a single process instead of in parallel.
(optional) description of the hook. Used for metadata purposes only.
(optional) see Overriding language version at https://pre-commit.com/#overriding-language-version
(optional) if present, the hook output will additionally be written to a file.
(optional) allows one to indicate a minimum compatible pre-commit version.
(optional) list of additional parameters to pass to the hook.
[]