Skip to content

Configure codespell to ignore generated files in subfolders #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2025

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 20, 2025

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.

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.
@per1234 per1234 self-assigned this Jun 20, 2025
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Jun 20, 2025
@per1234 per1234 merged commit 25aeaae into arduino:main Jun 20, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant