README.md 1.9 KB

check-spelling/check-spelling configuration

File | Purpose | Format | Info -|-|-|- dictionary.txt | Replacement dictionary (creating this file will override the default dictionary) | one word per line | dictionary allow.txt | Add words to the dictionary | one word per line (only letters and 's allowed) | allow reject.txt | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | reject excludes.txt | Files to ignore entirely | perl regular expression | excludes only.txt | Only check matching files (applied after excludes) | perl regular expression | only patterns.txt | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | patterns expect.txt | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | expect advice.md | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | advice

Note: you can replace any of these files with a directory by the same name (minus the suffix) and then include multiple files inside that directory (with that suffix) to merge multiple files together.