MNT: add a typo checker pre-commit hook

neutrinoceros · Jul 20, 2024 · 6e74830 · 6e74830
1 parent c95de37
commit 6e74830
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,6 +13,11 @@ repos:
   - id: end-of-file-fixer
   - id: check-toml
 
+- repo: https://github.com/crate-ci/typos
+  rev: v1.18.1
+  hooks:
+  - id: typos
+
 # this hook is broken on Python 3.12 because it depends on nodeenv, which is
 # still using removed and deprecated parts of the Python stdlib
 # see https://github.com/ekalinin/nodeenv/issues/343

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -7,5 +7,6 @@ exclude src/gpgi/_lib.py
 
 recursive-exclude tests *
 exclude .pre-commit-config.yaml
+exclude _typos.toml
 exclude constraints/*
 exclude requirements/*
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,3 @@
+[default.extend-words]
+ND = "ND"
+NDArray = "NDArray"