actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-12-26 17:42:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
typos/docs/reference.md
Ed Page 327a84a242 feat(ignore): Typos=specific ignores 
We want both CLI and config ignores.  The question then is what we make
them relative to.  I decided to favor CLI with `.`.  We'll see how this
works out

Fixes #134
2021-05-20 21:00:28 -05:00

2.5 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 one of typos.toml, _typos.toml, or .typos.toml

Config Fields

Field Argument Format Description
files.binary --binary bool Check binary files as text
files.extend-exclude --exclude 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.binary --binary bool Check binary files as text
default.check-filename - bool Verifying spelling in file names.
default.check-file - bool Verifying spelling in files.
default.unicode --unicode bool Allow unicode characters in identifiers (and not just ASCII)
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.locale --locale en, en-us, en-gb, en-ca, en-au English dialect to correct to.
default.extend-identifiers - table of strings Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid.
default.extend-words - table of strings Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid.
type.. See default. for child keys. Run with --type-list to see available <name>s
type..extend_globs - list of strings File globs for matching <name>