From 9fc46eb32a4fe362690a672c64a85d0dc9e7dc9c Mon Sep 17 00:00:00 2001 From: per1234 Date: Fri, 20 Jun 2025 08:17:03 -0700 Subject: [PATCH] Configure codespell to ignore generated files in subfolders The "codespell" tool is used to check for commonly misspelled words in the project files. This check should be performed on all files that are maintained by humans within the project. For the sake of efficiency, it should not be performed on externally maintained or machine generated files, since there is nothing that can be done within the project to resolve any misspelled words detected there. So the "asset" codespell configuration file contains a list of common externally maintained or machine generated paths to exclude. Previously the exclusions assumed the files would only be present in the root of the repository. Although that is most common, in some cases they may also be present in subfolders under the repository. The list of exclusions is hereby adjusted to cover those paths as well. --- .codespellrc | 2 +- workflow-templates/assets/spell-check/.codespellrc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.codespellrc b/.codespellrc index 3654513b..2885449e 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 = ba,licence,ot -skip = ./.git,./.licenses,__pycache__,node_modules,./other/clang-format-configuration/testdata/input/samples,./other/clang-format-configuration/testdata/golden,./other/clang-format-configuration/.clang-format,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock +skip = .git,./.licenses,__pycache__,node_modules,./other/clang-format-configuration/testdata/input/samples,./other/clang-format-configuration/testdata/golden,./other/clang-format-configuration/.clang-format,go.mod,go.sum,package-lock.json,poetry.lock,yarn.lock builtin = clear,informal,en-GB_to_en-US check-filenames = check-hidden = diff --git a/workflow-templates/assets/spell-check/.codespellrc b/workflow-templates/assets/spell-check/.codespellrc index a8608a40..9efecd6f 100644 --- a/workflow-templates/assets/spell-check/.codespellrc +++ b/workflow-templates/assets/spell-check/.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 = ./.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 =