DEV: Add codespell to pre-commit hooks

matthewfeickert · matthewfeickert · commit 55c4082ad0c7 · 2022-05-05T19:58:19.000-05:00
Add https://github.com/codespell-project/codespell as a pre-commit hook that checks for common misspellings of English words in files with the following extensions: .py, .c, .cpp, .h, .m, .md, .rst, .yml. Ignore instances of: * 'ans', 'axises', 'curvelinear', 'hist', 'nd', 'oly', 'thisy', 'wit' * 'ba' for bound axis and bound args * 'cannotation' for centered annotation * 'coo' for COO (Coordinate list) * 'flate' for Flate compression * 'inout' for lib/matplotlib/rcsetup.py * 'ment' for alignment with formatting * 'whis' for whikser plot * 'sur' for Big Sur * 'TE' for triangle elements and skip checking doc/users/project/credits.rst as the list of names of contributors isn't worth adding in to the ignore file to avoid false positives.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,3 +28,14 @@ repos:
       - id: flake8
         additional_dependencies: [pydocstyle>5.1.0, flake8-docstrings>1.4.0]
         args: ["--docstring-convention=all"]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+        files: ^.*\.(py|c|cpp|h|m|md|rst|yml)$
+        args: [
+          "--ignore-words",
+          "ci/codespell-ignore-words.txt",
+          "--skip",
+          "doc/users/project/credits.rst"
+          ]
diff --git a/ci/codespell-ignore-words.txt b/ci/codespell-ignore-words.txt
@@ -0,0 +1,17 @@
+ans
+axises
+ba
+cannotation
+coo
+curvelinear
+flate
+hist
+inout
+ment
+nd
+oly
+sur
+te
+thisy
+whis
+wit

-Original file line number
+Diff line change
@@ @@ -0,0 +1,17 @@ @@
 +ans
 +axises
 +ba
 +cannotation
 +coo
 +curvelinear
 +flate
 +hist
 +inout
 +ment
 +nd
 +oly
 +sur
 +te
 +thisy
 +whis
 +wit