Put codespell in pre-commit (#85)

* Add pre-commit hook for codespell

* Move codespell configuration to pyproject.toml

* Try multi-line skip entry for codespell config

* Revert change

* Remove GitHub Action for codespell in favor of pre-commit

.github/workflows/testing.yml

@@ -31,6 +31,9 @@ jobs:
           python: '3.11'
           noxenv: linters
 
+        - name: Import package
+          noxenv: import_package
+
     steps:
 
     - name: Checkout code

.pre-commit-config.yaml

@@ -69,3 +69,9 @@ repos:
   hooks:
   - id: absolufy-imports
     exclude: docs/plasmapy_sphinx
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.2
+  hooks:
+  - id: codespell
+    args: [--config pyproject.toml]

noxfile.py

@@ -33,12 +33,6 @@ def linters(session):
     session.run("flake8", "xrtpy", *flake8_options, *session.posargs)
 
 
-@nox.session
-def codespell(session):
-    session.install("codespell")
-    session.run("codespell", ".")
-
-
 @nox.session
 def import_package(session):
     session.install(".")

pyproject.toml

@@ -4,6 +4,11 @@ requires = ["setuptools >= 50.0",
             "wheel >= 0.34.0"]  # ought to mirror 'requirements/build.txt'
 build-backend = "setuptools.build_meta"
 
+[tool.codespell]
+skip = "*.genx,*.geny,*.png,*egg*,.git,.hypothesis,.nox,.tox,.idea,__pycache__,_build"
+ignore-words-list = """
+circularly"""
+
 [tool.gilesbot]
 
 [tool.gilesbot.pull_requests]

setup.cfg

@@ -219,12 +219,3 @@ exclude_lines =
     @jit
     @numba.njit
     @njit
-
-[codespell]
-
-skip = *.genx,*.geny,*.png,*egg*,.git,.hypothesis,.nox,.tox,__pycache__,_build
-
-# Occasionally codespell will have false positives. Put words here that
-# should be ignored when codespell checks spellings.
-ignore-words-list =
-    circularly