2019-10-25 10:17:58 -04:00
|
|
|
# `typos` Reference
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
### Sources
|
|
|
|
|
|
|
|
|
|
Configuration is read from the following (in precedence order)
|
|
|
|
|
|
|
|
|
|
- Command line arguments
|
2019-10-25 11:39:55 -04:00
|
|
|
- File specified via `--config PATH`
|
|
|
|
|
- Search parents of specified file / directory for `typos.toml`
|
2019-10-25 10:17:58 -04:00
|
|
|
|
|
|
|
|
### Config Fields
|
|
|
|
|
|
|
|
|
|
| Field | Argument | Format | Description |
|
|
|
|
|
|------------------------|-------------------|--------|-------------|
|
2020-05-27 21:46:41 -04:00
|
|
|
| files.binary | --binary | bool | Check binary files as text |
|
2020-08-25 21:54:42 -04:00
|
|
|
| files.ignore-patterns | | list of strings | Typos-specific ignore globs (gitignore syntax) |
|
2020-05-27 21:46:41 -04:00
|
|
|
| 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 | |
|
