Expand codespell file exclusions to cover more generated files #168
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
…ple 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.
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.
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 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.