Add --min-word-length option to ignore short words#3971
Open
ekanshul wants to merge 1 commit into
Open
Conversation
Words shorter than the given length are dropped from the misspelling dictionary up front, so they are ignored both in file contents and with --check-filenames. This avoids having to list every short variable name in --ignore-words-list. Closing: codespell-project#2211
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
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.
Closes #2211
Adds a
--min-word-length LENGTHoption so that words shorter than LENGTH are not checked. This helps with codebases full of 2-3 letter variable names that would otherwise each need an entry in--ignore-words-list.Implementation: entries shorter than LENGTH are dropped from the misspelling dictionary right after it is built, so short words are ignored consistently everywhere (file contents, stdin and
--check-filenames) with no per-word cost during scanning. The default (0) keeps current behavior.Example:
Tests included (
test_min_word_length) covering the length boundaries, case-insensitivity and--check-filenames.