.pre-commit-config.yml
pre-commit configuration file
.pre-commit-config.yml.pre-commit-config.yaml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.pre-commit-config.yml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
ci | object | pre-commit.ci specific settings https://pre-commit.ci/#configuration |
ci.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… |
ci.autofix_prs | boolean | Whether to autofix pull requests https://pre-commit.ci/#configuration default: true |
ci.autoupdate_branch | string | A branch to send pull request's autoupdate to https://pre-commit.ci/#configuration default: "" |
ci.autoupdate_commit_msg | string | A commit message for autoupdate pull requests https://pre-commit.ci/#configuration default: "[pre-commit.ci] pre-commit autoupdate" |
ci.autoupdate_schedule | string | An autoupdate frequency https://pre-commit.ci/#configuration default: "weekly"one of: "weekly", "monthly", "quarterly" |
ci.skip | array<string> | List of skipped hook's ids https://pre-commit.ci/#configuration |
ci.submodules | boolean | Whether to recursively check out submodules https://pre-commit.ci/#configuration default: false |
reposrequired | array | Repository mappings of the current project https://pre-commit.com/#pre-commit-configyaml---top-level |
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 | object | Mappings for the default language versions of the current project https://pre-commit.com/#pre-commit-configyaml---top-level |
default_stages | any | 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" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Has 2 place(s) where keywords sit beside
$ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at#/definitions/local_repo/properties/hooks/items. - 42 properties, 90% carrying a description, max nesting depth 8.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.