actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-24 18:10:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add reference

Browse source
This commit is contained in:
Ed Page 2019-10-25 08:17:58 -06:00
parent 851336b931
commit 5863158a31
2 changed files with 32 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -8,9 +8,11 @@
![License](https://img.shields.io/crates/l/typos.svg)
[![Crates Status](https://img.shields.io/crates/v/typos.svg)](https://crates.io/crates/typos)
## [About](docs/about.md)
## [Install](docs/install.md)
## [About](docs/about.md)
## [Reference](docs/reference.md)
## [Contribute](CONTRIBUTING.md)

29
docs/reference.md Normal file
View file

@ -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 | |