Commit d36818c
committed
Add a black check to pre-commit
- Add the psf/black-pre-commit-mirror pre-commit hook but have it
just check and report violations rather than fixing them
automatically (to avoid inconsistency with all the other hooks,
and also so that the linting instructions and CI lint workflow
can remain the same and automatically do the black check).
- Remove the "black" environment from tox.ini, since it is now part
of the linting done in the "lint" environment. (But README.md
remains the same, as it documented actually auto-formatting with
black, which is still done the same way.)
- Add missing "exclude" keys for the shellcheck and black
pre-commit hooks to explicitly avoid traversing into the
submodules.1 parent b88d07e commit d36818c
2 files changed
Lines changed: 9 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,11 @@ | |||
| 1 | 1 | repos: | |
| 2 | + - repo: https://github.com/psf/black-pre-commit-mirror | ||
| 3 | + rev: 23.9.1 | ||
| 4 | + hooks: | ||
| 5 | + - id: black | ||
| 6 | + args: [--check, --diff] | ||
| 7 | + exclude: ^git/ext/ | ||
| 8 | + | ||
| 2 | 9 | - repo: https://github.com/PyCQA/flake8 | |
| 3 | 10 | rev: 6.1.0 | |
| 4 | 11 | hooks: | |
@@ -14,6 +21,7 @@ repos: | |||
| 14 | 21 | hooks: | |
| 15 | 22 | - id: shellcheck | |
| 16 | 23 | args: [--color] | |
| 24 | + exclude: ^git/ext/ | ||
| 17 | 25 | ||
| 18 | 26 | - repo: https://github.com/pre-commit/pre-commit-hooks | |
| 19 | 27 | rev: v4.4.0 | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,6 +1,6 @@ | |||
| 1 | 1 | [tox] | |
| 2 | 2 | requires = tox>=4 | |
| 3 | - env_list = py{37,38,39,310,311,312}, lint, mypy, black | ||
| 3 | + env_list = py{37,38,39,310,311,312}, lint, mypy | ||
| 4 | 4 | ||
| 5 | 5 | [testenv] | |
| 6 | 6 | description = Run unit tests | |
@@ -20,11 +20,6 @@ base_python = py39 | |||
| 20 | 20 | commands = mypy -p git | |
| 21 | 21 | ignore_outcome = true | |
| 22 | 22 | ||
| 23 | - [testenv:black] | ||
| 24 | - description = Check style with black | ||
| 25 | - base_python = py39 | ||
| 26 | - commands = black --check --diff . | ||
| 27 | - | ||
| 28 | 23 | # Run "tox -e html" for this. It is deliberately excluded from env_list, as | |
| 29 | 24 | # unlike the other environments, this one writes outside the .tox/ directory. | |
| 30 | 25 | [testenv:html] | |
0 commit comments