@@ -29,7 +29,7 @@ it takes a bit longer. For more details, read below.
29
29
Typeshed runs continuous integration (CI) on all pull requests. This means that
30
30
if you file a pull request (PR), our full test suite -- including our linter,
31
31
` flake8 ` -- is run on your PR. It also means that bots will automatically apply
32
- changes to your PR (using ` black ` and ` isort ` ) to fix any formatting issues.
32
+ changes to your PR (using ` pycln ` , ` black ` and ` isort ` ) to fix any formatting issues.
33
33
This frees you up to ignore all local setup on your side, focus on the
34
34
code and rely on the CI to fix everything, or point you to the places that
35
35
need fixing.
@@ -92,17 +92,19 @@ pip install termcolor
92
92
93
93
## Code formatting
94
94
95
- The code is formatted using ` black ` and ` isort ` .
95
+ The code is formatted using ` black ` and ` isort ` . Unused imports are also
96
+ auto-removed using ` pycln ` .
96
97
97
98
The repository is equipped with a [ ` pre-commit.ci ` ] ( https://pre-commit.ci/ )
98
99
configuration file. This means that you don't * need* to do anything yourself to
99
100
run the code formatters. When you push a commit, a bot will run those for you
100
101
right away and add a commit to your PR.
101
102
102
103
That being said, if you * want* to run the checks locally when you commit,
103
- you're free to do so. Either run ` black ` and ` isort ` manually...
104
+ you're free to do so. Either run ` pycln ` , ` black ` and ` isort ` manually...
104
105
105
106
```
107
+ pycln --all .
106
108
isort .
107
109
black .
108
110
```
0 commit comments