Pre-Commit

February 21, 2023 ยท View on GitHub

Used for maintaining Git hooks. Must be installed globally on the respective system. As it is written in Python, for example pipx can be used to install it.

Whenever this repository is initially cloned, the following should be executed:

pre-commit install --install-hooks
pre-commit install --install-hooks --hook-type commit-msg

Pre-commit should now run on every commit. It is also used in GitHub Actions.

Pre-commit is configured via .pre-commit-config.yaml.

Housekeeping

Update hooks

pre-commit autoupdate

Cheat Sheet

Run pre-commit against all files

pre-commit run -a

Run specific hook against all files

pre-commit run -a <hook>