1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# Pre-Commit
Used for maintaining Git hooks. Must be installed globally on the respective
system. As it is written in Python, for example
[`pipx`](https://github.com/pypa/pipx) can be used to install it.
- [pre-commit.com](https://pre-commit.com)
- [github.com/pre-commit/pre-commit](https://github.com/pre-commit/pre-commit)
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`](../.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>
```
|
