Skip to content

Commit a21c596

Browse files
committed
Use .codespellrc file to configure spell check
The recent 2.0.0 release of the codespell tool used by the "Spell Check" CI workflow added support for configuring the tool via a configuration file. Use of this file allows the spell check to easily be run by contributors locally with the identical configuration as will be done in the CI. It replaces extras/codespell-ignore-words-list.txt.
1 parent 396cfdb commit a21c596

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

.codespellrc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See: https://github.com/codespell-project/codespell#using-a-config-file
2+
[codespell]
3+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4+
ignore-words-list = ,
5+
check-filenames =
6+
check-hidden =
7+
skip = ./.git,./src/libmodbus

.github/workflows/spell-check.yml

-6
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,3 @@ jobs:
1818
# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
1919
- name: Spell check
2020
uses: codespell-project/actions-codespell@master
21-
with:
22-
check_filenames: true
23-
check_hidden: true
24-
# In the event of a false positive, add the word in all lower case to this file:
25-
ignore_words_file: extras/codespell-ignore-words-list.txt
26-
skip: ./.git,./src/libmodbus

extras/codespell-ignore-words-list.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)