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
Type: object[]

Items

object
id string required

id of the hook - used in pre-commit-config.yaml.

name string required

name of the hook - shown during hook execution.

entry string required

entry point - the executable to run. Can also contain arguments that will not be overridden such as entry: autopep8 -i.

language string | string required
alias string

(optional) allows the hook to be referenced using an additional id.

files string

(optional) the pattern of files to run on.

Default: ""
exclude string

(optional) exclude files that were matched by files.

Default: "^$"
types file_type[]
types_or file_type[]
exclude_types file_type[]
additional_dependencies string[]

(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.

always_run boolean

(optional) if true this hook will run even if there are no matching files.

Default: false
fail_fast boolean

(optional) if true this hook will run even if there are no matching files.

Default: false
verbose boolean

(optional) if true, forces the output of the hook to be printed even when the hook passes.

Default: false
pass_filenames boolean

(optional) if false no filenames will be passed to the hook.

Default: true
require_serial boolean

(optional) if true this hook will execute using a single process instead of in parallel.

Default: false
description string

(optional) description of the hook. Used for metadata purposes only.

Default: ""
language_version string

(optional) see Overriding language version at https://pre-commit.com/#overriding-language-version

Default: "default"
log_file string

(optional) if present, the hook output will additionally be written to a file.

minimum_pre_commit_version string

(optional) allows one to indicate a minimum compatible pre-commit version.

Default: "0"
args string[]

(optional) list of additional parameters to pass to the hook.

Default:
[]
stages stage[]

Definitions

language string | string
file_type string | string
file_types file_type[]
stage string
stages stage[]