From fd2254365ebe79122b306a07e4e5194d5940f011 Mon Sep 17 00:00:00 2001 From: Per Tillisch Date: Tue, 28 Oct 2025 02:20:28 -0700 Subject: [PATCH 1/2] Add codespell configuration file This file defines Arduino's standardized configuration for the codespell spellchecker tool. The file will also allow project specific configuration of exclusions to fix false positives. --- .codespellrc | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..9efecd6 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,9 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc +# 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 = , +skip = ./.licenses,.git,__pycache__,node_modules,go.mod,go.sum,package-lock.json,poetry.lock,yarn.lock +builtin = clear,informal,en-GB_to_en-US +check-filenames = +check-hidden = From 4d0ee9624fabf4218838d755f711123d9351535e Mon Sep 17 00:00:00 2001 From: Per Tillisch Date: Tue, 28 Oct 2025 02:26:08 -0700 Subject: [PATCH 2/2] Fix spellcheck false positive The codespell spellchecker tool is used to detect occurrences of commonly misspelled words in the project files. The project readme references the acronym "ALS" (ambient light sensor). This happens to be in the codespell misspelled word dictionary as a misspelling of "also", and so causes a failure of the spellcheck. The false positive is resolved by adding the word to the ignore list in the codespell configuration. --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index 9efecd6..b397ede 100644 --- a/.codespellrc +++ b/.codespellrc @@ -2,7 +2,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 = , +ignore-words-list = als skip = ./.licenses,.git,__pycache__,node_modules,go.mod,go.sum,package-lock.json,poetry.lock,yarn.lock builtin = clear,informal,en-GB_to_en-US check-filenames =