actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-29 04:21:06 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
typos/docs/reference.md
Ed Page 043692afe0 feat(dict): Override builtin dictionary 
Sometimes you just have to live with a typo or its done intentionally
(like weird company names).  With this commit, a user can now identifier
blessed identifiers and words.

This is ostly what is needed for #9 but sometimes people will have
common typos that they'll want to provide corrections for.
2020-09-02 20:24:54 -05:00

2.4 KiB
Raw Blame History

typos Reference

Configuration

Sources

Configuration is read from the following (in precedence order)

  • Command line arguments
  • File specified via --config PATH
  • Search parents of specified file / directory for typos.toml

Config Fields

Field Argument Format Description
files.binary --binary bool Check binary files as text
files.ignore-patterns list of strings Typos-specific ignore globs (gitignore syntax)
files.ignore-hidden --hidden bool Skip hidden files and directories.
files.ignore-files --ignore bool Respect ignore files.
files.ignore-dot --ignore-dot bool Respect .ignore files.
files.ignore-vcs --ignore-vcs bool Respect ignore files in vcs directories.
files.ignore-global --ignore-global bool Respect global ignore files.
files.ignore-parent --ignore-parent bool Respect ignore files in parent directories.
default.check-filename - bool Verifying spelling in file names.
default.check-file - bool Verifying spelling in files.
default.ignore-hex - bool Do not check identifiers that appear to be hexadecimal values.
default.identifier-leading-digits - bool Allow identifiers to start with digits, in addition to letters.
default.identifier-include-digits - bool Allow identifiers to include digits, in addition to letters.
default.identifier-leading-chars - string Allow identifiers to start with one of these characters.
default.identifier-include-chars - string Allow identifiers to include these characters.
default.locale - en, en-us, en-gb, en-ca, en-au English dialect to correct to.
default.extend-valid-identifiers - list of strings Identifiers to presume as correct, skipping spell checking. This extends the list when layering configuration, rather than replacing it.
default.extend-valid-words - list of strings Words to presume as correct, skipping spell checking. This extends the list when layering configuration, rather than replacing it.