Configure codespell to ignore generated files in subfolders #186
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.