-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ed Page
committed
Oct 25, 2019
1 parent
851336b
commit 5863158
Showing
2 changed files
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# `typos` Reference | ||
|
||
## Configuration | ||
|
||
### Sources | ||
|
||
Configuration is read from the following (in precedence order) | ||
|
||
- Command line arguments | ||
- Either | ||
- File specified via `--config PATH` | ||
- Search parents of specified file / directory for `typos.toml` | ||
|
||
### Config Fields | ||
|
||
| Field | Argument | Format | Description | | ||
|------------------------|-------------------|--------|-------------| | ||
| files.binary | --binary | bool | | | ||
| files.ignore-hidden | --hidden | bool | | | ||
| files.ignore-files | --ignore | bool | | | ||
| files.ignore-dot | --ignore-dot | bool | | | ||
| files.ignore-vcs | --ignore-vcs | bool | | | ||
| files.ignore-global | --ignore-global | bool | | | ||
| files.ignore-parent | --ignore-parent | bool | | | ||
| default.check-filename | \- | bool | | | ||
| default.check-file | \- | bool | | | ||
| default.ignore-hex | \- | bool | | | ||
| default.identifier-include-digits | \- | bool | | | ||
| default.identifier-include-chars | \- | string | | |