feat: Run codespell via pre-commit

Author: l0b0

.github/workflows/continuous-integration.yml

@@ -103,7 +103,7 @@ jobs:
           pip install -r requirements-test.txt
 
       - name: Execute linters & type checkers
-        run: ./scripts/lint
+        run: pre-commit run --all-files
 
   vanilla:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -11,6 +11,14 @@ repos:
         stages: [commit]
         types: [python]
 
+      - id: codespell
+        name: codespell
+        entry: codespell
+        args: [--ignore-words=.codespellignore]
+        language: system
+        stages: [commit]
+        types_or: [jupyter, markdown, python, shell]
+
       - id: doc8
         name: doc8
         entry: doc8

README.md

@@ -91,12 +91,6 @@ To run these automatically when committing files (runs only on the staged files)
 
 To avoid running these checks when committing, use `git commit --no-verify`.
 
-To check for spelling mistakes in modified files:
-
-```
-> git diff --name-only | xargs codespell -I .codespellignore -f
-```
-
 You can also run the `./scripts/test` script to check for linting, spelling, and run unit tests.
 
 ### Continuous Integration

docs/contributing.rst

@@ -48,6 +48,7 @@ Code quality checks
 PySTAC uses
 
 - `black <https://github.com/psf/black>`_ for Python code formatting
+- `codespell <https://github.com/codespell-project/codespell/>`_ to check code for common misspellings
 - `doc8 <https://github.com/pycqa/doc8>`__ for style checking on RST files in the docs
 - `flake8 <http://flake8.pycqa.org/en/latest/>`_ for Python style checks
 - `mypy <http://www.mypy-lang.org/>`_ for Python type annotation checks

scripts/lint

@@ -3,7 +3,7 @@
 set -e
 
 if [[ -z ${CI} ]]; then
-    source ./scripts/lint
+    pre-commit run --all-files
 fi
 
 echo