Skip to content

Commit

Permalink
docs: Add reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Ed Page committed Oct 25, 2019
1 parent 851336b commit 5863158
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
29 changes: 29 additions & 0 deletions docs/reference.md
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 | |

0 comments on commit 5863158

Please sign in to comment.