Merge pull request #66 from hf-kklein/spell-check

Add CI Action with Spell Check
mj0nez · Jan 2, 2024 · 3ed96e3 · 3ed96e3
2 parents db4314d + ff1d0d9
commit 3ed96e3
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 0 deletions.
diff --git a/dev_requirements/requirements-spell_check.in b/dev_requirements/requirements-spell_check.in
@@ -0,0 +1 @@
+codespell
diff --git a/dev_requirements/requirements-spell_check.txt b/dev_requirements/requirements-spell_check.txt
@@ -0,0 +1,8 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements-spellcheck.in
+#
+codespell==2.2.6
+    # via -r dev_requirements/requirements-spell_check.in
diff --git a/domain-specific-terms.txt b/domain-specific-terms.txt
@@ -0,0 +1,11 @@
+bdew
+alle
+tage
+oder
+generell
+frist
+als
+beginn
+ist
+tages
+vor
diff --git a/tox.ini b/tox.ini
@@ -67,3 +67,15 @@ deps =
 commands =
     python -m build
     twine check dist/*
+
+[testenv:spell_check]
+# the spellcheck environment checks the code for typos
+setenv = PYTHONPATH = {toxinidir}/src
+deps =
+    -r requirements.txt
+    -r dev_requirements/requirements-spell_check.txt
+commands =
+    codespell --ignore-words=domain-specific-terms.txt src/bdew_datetimes
+    codespell --ignore-words=domain-specific-terms.txt README.md
+    # add single files (ending with .py) or packages here
+    # note that domain-specific-terms.txt (the ignore list of the spell checker) has to contain the ignored words in all lower case