From 5ec42f90eed49e886eb96ad156b4332ab3d21493 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 26 May 2021 03:56:23 -0700 Subject: Add CI workflow to check for commonly misspelled words On every push, pull request, and periodically, use the codespell-project/actions-codespell action to check for commonly misspelled words. In the event of a false positive, the problematic word should be added, in all lowercase, to the ignore-words-list field of ./.codespellrc. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore list. The ignore list is comma-separated with no spaces. --- .codespellrc | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .codespellrc (limited to '.codespellrc') diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..6aace1d --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +# See: https://github.com/codespell-project/codespell#using-a-config-file +[codespell] +# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: +ignore-words-list = hart,pullrequest +check-filenames = +check-hidden = +skip = ./.git,./firmwares/arduinoISP,./firmwares/wifishield,./bootloaders -- cgit v1.2.3-18-g5258 From 4899e506bbddf4561d51ea1c04a88335ad5f9907 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 30 Jun 2021 04:38:56 -0700 Subject: Don't use codespell's "rare" dictionary for CI spell check The word "statics" was recently added to codespell's "rare" commonly mispelled words directory. By default, this dictionary is used in addition to the more conservative "clear" dictionary, resulting in a spurious failure of the "Spell Check" CI workflow. Although this could be fixed by adding the word to the ignore list, it seems that an increasing number of common words being added to this dictionary, so I think it's best to just remove it altogether. The goal for the "Spell Check" workflow is to catch some typos without a significant number of false positives, even if that means some misspellings slip through. I think the "clear" dictionary is more in line with that goal. --- .codespellrc | 1 + 1 file changed, 1 insertion(+) (limited to '.codespellrc') diff --git a/.codespellrc b/.codespellrc index 6aace1d..d5d337d 100644 --- a/.codespellrc +++ b/.codespellrc @@ -2,6 +2,7 @@ [codespell] # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: ignore-words-list = hart,pullrequest +builtin = clear check-filenames = check-hidden = skip = ./.git,./firmwares/arduinoISP,./firmwares/wifishield,./bootloaders -- cgit v1.2.3-18-g5258