Skip to content

Commit

Permalink
Add CI Action with Spell Check
Browse files Browse the repository at this point in the history
Add ignore list for spell-checker
  • Loading branch information
hf-kklein committed Jan 2, 2024
1 parent 4724ac3 commit 20b80c8
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions dev_requirements/requirements-spell_check.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
codespell
8 changes: 8 additions & 0 deletions dev_requirements/requirements-spell_check.txt
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions domain-specific-terms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
bdew
alle
tage
oder
generell
frist
als
beginn
ist
tages
vor
12 changes: 12 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 20b80c8

Please sign in to comment.