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
line_forbidden.patterns	Patterns to flag in 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.

If the flagged items are false positives

If items relate to a ...

• binary file (or some other file you wouldn't want to check at all).

  Please add a file path to the excludes.txt file matching the containing file.

  File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

  ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

• well-formed pattern.

  If you can write a pattern that would match it, try adding it to the patterns.txt file.

  Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

  Note that patterns can't match multiline strings.