precommitconfigyaml

Precommitconfigyaml refers to the configuration file used by the pre-commit framework to declare and manage code quality checks that run before commits. The conventional file name is .pre-commit-config.yaml and it is placed at the root of a repository. The file is written in YAML and is typically tracked in version control to ensure consistent behavior across environments.

The top-level structure of the file centers on a list of repositories. Each repository entry specifies a repo URL and a revision to pin a specific version, and may include a list of hooks. Each hook is identified by an id and can carry optional fields such as name, args, files, exclude, stages, language_version, and other hook-specific options. Hooks are executed according to their configuration whenever a commit is attempted, and file matching patterns help determine which files are processed.

Typical usage involves installing the git hooks into the repository with a command like pre-commit install. After installation, checks run automatically on commits. Users can invoke hooks manually with pre-commit run or run them against all files with pre-commit run --all-files. The autoupdate command can refresh hook revisions. The configuration supports multiple repositories and languages, enabling a consistent set of checks across diverse projects.

Best practices include pinning revisions to ensure reproducibility, keeping the configuration under version control, and including a mix of commonly used hooks such as formatters, linters, and security checks. The file .pre-commit-config.yaml serves as a centralized, declarative specification of pre-commit behavior for a project.