Run pycln as a pre-commit hook in CI

Author: AlexWaygood

.pre-commit-config.yaml

@@ -1,4 +1,9 @@
 repos:
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.0.2 # must match requirements-tests.txt
+    hooks:
+      - id: pycln
+        args: [--config=pyproject.toml]
   - repo: https://github.com/psf/black
     rev: 22.6.0 # must match requirements-tests.txt
     hooks:

CONTRIBUTING.md

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

pyproject.toml

@@ -47,3 +47,6 @@ extra_standard_library = [
     "UserList",
     "UserString",
 ]
+
+[tool.pycln]
+all = true

requirements-tests.txt

@@ -9,3 +9,4 @@ flake8-pyi==22.5.1
 # must match .pre-commit-config.yaml
 isort==5.10.1
 tomli==1.2.2
+pycln==2.0.2