Skip to content

Commit 4769b4a

Browse files
codespell: Move options into .codespellrc
Previously, options were listed in the github workflow file, but by moving them into the .codespellrc file you can also just run the `codespell` command locally to see the same results as in the github workflow. This also fixes the options (using ignore-words-list as an actual list instead of pointing to a file like ignore-words is intended for) and uses skip to exclude files instead of exclude-file which seems intended to point to a file containing excludes. Additionally, this tweaks the options a bit (adding more skips) and removes the codespell-ignore-words-list.txt file (putting them in the .codespellrc file directly).
1 parent 2642d5d commit 4769b4a

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

.codespellrc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[codespell]
2+
skip = ./src/STM32CubeWL,./src/BSP/timer_if.*,./api-docs,./.git
3+
# The presence of these values enables them
4+
check-filenames =
5+
check-hidden =
6+
# In the event of a false positive, add the word in all lower case to this value (comma-separated string)
7+
ignore-words-list = wan

.github/workflows/CodeSpell.yml

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

extras/codespell-ignore-words-list.txt

-1
This file was deleted.

0 commit comments

Comments
 (0)