.pre-commit-config.yml

pre-commit configuration file

Type object
File match .pre-commit-config.yml .pre-commit-config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/pre-commit-config-yml/latest.json
Source https://www.schemastore.org/pre-commit-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

repos meta_repo | local_repo | uri_repo[] required

Repository mappings of the current project https://pre-commit.com/#pre-commit-configyaml---top-level

ci object

pre-commit.ci specific settings https://pre-commit.ci/#configuration

7 nested properties
autofix_commit_msg string

A commit message for pull request autofixes https://pre-commit.ci/#configuration

Default: "[pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci"
autofix_prs boolean

Whether to autofix pull requests https://pre-commit.ci/#configuration

Default: true
autoupdate_branch string

A branch to send pull request's autoupdate to https://pre-commit.ci/#configuration

Default: ""
autoupdate_commit_msg string

A commit message for autoupdate pull requests https://pre-commit.ci/#configuration

Default: "[pre-commit.ci] pre-commit autoupdate"
autoupdate_schedule string

An autoupdate frequency https://pre-commit.ci/#configuration

Default: "weekly"
Values: "weekly" "monthly" "quarterly"
skip string[]

List of skipped hook's ids https://pre-commit.ci/#configuration

submodules boolean

Whether to recursively check out submodules https://pre-commit.ci/#configuration

Default: false
default_install_hook_types array

A list of hook types which will be used by default when running pre-commit install https://pre-commit.com/#pre-commit-configyaml---top-level

Default:
[
  "pre-commit"
]
default_language_version Record<string, string>

Mappings for the default language versions of the current project https://pre-commit.com/#pre-commit-configyaml---top-level

default_stages stages

The default stages of the current project https://pre-commit.com/#pre-commit-configyaml---top-level

files string

A file include pattern of the current project https://pre-commit.com/#pre-commit-configyaml---top-level

Default: ""
exclude string

A file exclude pattern of the current project https://pre-commit.com/#pre-commit-configyaml---top-level

Default: "^$"
fail_fast boolean

Whether stop running hooks after a first failure https://pre-commit.com/#pre-commit-configyaml---top-level

Default: false
minimum_pre_commit_version string

A minimum version of pre-commit https://pre-commit.com/#pre-commit-configyaml---top-level

Default: "0"

Definitions

meta_repo object
repo enum
Default: "meta"
Values: "meta"
hooks object[]
local_repo object
repo string

A list of local hooks https://pre-commit.com/#2-add-a-pre-commit-configuration

Default: "local"
Values: "local"
hooks object[]
uri_repo object
repo string

A repository url https://pre-commit.com/#2-add-a-pre-commit-configuration

pattern=^(?!(?:meta|local)$).*$
rev string

A revision or tag to clone at https://pre-commit.com/#2-add-a-pre-commit-configuration

hooks object[]

A list of hook mappings https://pre-commit.com/#pre-commit-configyaml---hooks.

hook_definition object
id string

An identifier of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

alias string

An additional identifier of the current hook for pre-commit run <hookid> https://pre-commit.com/#pre-commit-configyaml---hooks

name string

A name of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

language_version string

A language version of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

files string

A pattern to include files to run on of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

exclude string

A pattern to exclude files from files to run on of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

types file_types

A list of file types to run on combined via logical and of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

types_or file_types

A list of file types to run on combined via logical or of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

exclude_types file_types

A list of file types to exclude of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

args string[]

List of additional parameters to pass to the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

stages stages

A stage of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

additional_dependencies string[]

A list of additional_dependencies of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

always_run boolean

Run the current hook when no files matched https://pre-commit.com/#pre-commit-configyaml---hooks

verbose boolean

Display an output of the current hook even it passes https://pre-commit.com/#pre-commit-configyaml---hooks

entry string

A command of the current hook https://pre-commit.com/#pre-commit-configyaml---hooks

log_file string

A log file of the current hook

language language

A language the current hook is written in https://pre-commit.com/#pre-commit-configyaml---hooks

pass_filenames boolean

Whether to pass filenames to the current hook or not https://pre-commit.com/#pre-commit-configyaml---hooks

Default: true