Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit5d8ddd9

Browse files
committed
Use two hooks for black: to check, and format
This splits the pre-commit hook for black into two hooks, bothusing the same repo and id but separately aliased:- black-check, which checks but does not modify files. This only runs when the manual stage is specified, and it is used by tox and on CI, with tox.ini and lint.yml modified accordingly.- black-format, which autoformats code. This provides the behavior most users will expect from a pre-commit hook for black. It runs automatically along with other hooks. But tox.ini and lint.yml, in addition to enabling the black-check hook, also explicitly skip the black-format hook.The effect is that in ordinary development the pre-commit hook forblack does auto-formatting, but that pre-commit continues to beused effectively for running checks in which code should not bechanged.
1 parent4ba5ad1 commit5d8ddd9

File tree

4 files changed

+21
-7
lines changed

4 files changed

+21
-7
lines changed

‎.github/workflows/lint.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@ jobs:
1414
python-version:"3.x"
1515

1616
-uses:pre-commit/action@v3.0.0
17+
with:
18+
extra_args:--hook-stage manual
19+
env:
20+
SKIP:black-format

‎.pre-commit-config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@ repos:
33
rev:23.9.1
44
hooks:
55
-id:black
6+
alias:black-check
7+
name:black (check)
68
args:[--check, --diff]
79
exclude:^git/ext/
10+
stages:[manual]
11+
12+
-id:black
13+
alias:black-format
14+
name:black (format)
15+
exclude:^git/ext/
816

917
-repo:https://github.com/PyCQA/flake8
1018
rev:6.1.0

‎README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,22 +142,22 @@ To test, run:
142142
pytest
143143
```
144144

145-
To lint, run:
145+
To lint,and apply automatic code formatting,run:
146146

147147
```bash
148148
pre-commit run --all-files
149149
```
150150

151-
To typecheck, run:
151+
Code formatting can also be done by itself by running:
152152

153-
```bash
154-
mypy -p git
153+
```
154+
black .
155155
```
156156

157-
For automatic code formatting, run:
157+
To typecheck, run:
158158

159159
```bash
160-
black.
160+
mypy -p git
161161
```
162162

163163
Configuration for flake8 is in the`./.flake8` file.

‎tox.ini

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ commands = pytest --color=yes {posargs}
1212
[testenv:lint]
1313
description = Lint via pre-commit
1414
base_python = py39
15-
commands = pre-commit run --all-files
15+
set_env =
16+
SKIP = black-format
17+
commands = pre-commit run --all-files --hook-stage manual
1618

1719
[testenv:mypy]
1820
description = Typecheck with mypy

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp