actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 09:01:04 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
typos/docs/reference.md

35 lines
2.4 KiB
Markdown
Raw Normal View History

docs: Add reference
2019-10-25 10:17:58 -04:00
# `typos` Reference
## Configuration
### Sources
Configuration is read from the following (in precedence order)
- Command line arguments
docs: Fix source precedence
2019-10-25 11:39:55 -04:00
- File specified via `--config PATH`
- Search parents of specified file / directory for `typos.toml`
docs: Add reference
2019-10-25 10:17:58 -04:00
### Config Fields
| Field | Argument | Format | Description |
|------------------------|-------------------|--------|-------------|
feat: Support english dialects The goal is to be as accepting and unobtrusive to new code bases as possible. To this end, we correct typos into the closest english dialect. If someone wants to opt-in, they can have typos correct to a specific english dialect. Fixes #52 Fixes #22
2020-05-27 21:46:41 -04:00
| files.binary | --binary | bool | Check binary files as text |
feat(ignore): Typos-specific ignores THis is to help with cases like a monorepo with vendored dependencies. A user might want to search (`.ignore`) them but not hold the code to the same standards as first-party code. Fixes #134
2020-08-25 21:54:42 -04:00
| files.ignore-patterns | | list of strings | Typos-specific ignore globs (gitignore syntax) |
feat: Support english dialects The goal is to be as accepting and unobtrusive to new code bases as possible. To this end, we correct typos into the closest english dialect. If someone wants to opt-in, they can have typos correct to a specific english dialect. Fixes #52 Fixes #22
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. |
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 21:12:49 -04:00
| 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. |
Reference in a new issue Copy permalink