From b38231d9f5dabaceb52992c527b5ce615e4aa483 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 4 Jun 2025 02:04:43 -0700 Subject: [PATCH 1/2] Adjust codespell file exclusions to support projects containing multiple Go modules The "codespell" tool is used to check for the presence of commonly misspelled words in the project files. Since we don't have control over their content, automatically generated files should be excluded from such checks for efficiency and to avoid false positives. This includes the `go.mod` and `go.sum` Go module metadata files. Projects may contain multiple Go modules in subfolders of the repository, each with their own metadata files. Previously, the codespell configuration only excluded `go.mod` and `go.sum` in the root of the repository. --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index a8608a4..a4ff877 100644 --- a/.codespellrc +++ b/.codespellrc @@ -3,7 +3,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 = , -skip = ./.git,./.licenses,__pycache__,node_modules,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock +skip = ./.git,./.licenses,__pycache__,go.mod,go.sum,node_modules,./package-lock.json,./poetry.lock,./yarn.lock builtin = clear,informal,en-GB_to_en-US check-filenames = check-hidden = From f2e387d9a2517fa50e4bda9ebe7e220ff0274730 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 4 Jun 2025 02:14:57 -0700 Subject: [PATCH 2/2] Exclude project binary file from codespell The "codespell" tool is used to check for the presence of commonly misspelled words in the project files. Automatically generated files should be excluded from such checks for efficiency and to avoid false positives. Although they are not checked into the repository, when contributors build the project the binary files will be present in the project folder and thus subject to such checks. "codespell" is smart enough to automatically detect binary files and not check their content, but it will be best to explicitly configure it to skip the files entirely for the sake of efficiency. --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index a4ff877..5d6e690 100644 --- a/.codespellrc +++ b/.codespellrc @@ -3,7 +3,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 = , -skip = ./.git,./.licenses,__pycache__,go.mod,go.sum,node_modules,./package-lock.json,./poetry.lock,./yarn.lock +skip = ./.git,./.licenses,__pycache__,go.mod,go.sum,node_modules,./package-lock.json,./poetry.lock,./yarn.lock,./arduinoOTA,./arduinoOTA.exe builtin = clear,informal,en-GB_to_en-US check-filenames = check-hidden =