From 5863158a319d9727a3874a43f73da09fe49f935e Mon Sep 17 00:00:00 2001 From: Ed Page Date: Fri, 25 Oct 2019 08:17:58 -0600 Subject: [PATCH] docs: Add reference --- README.md | 4 +++- docs/reference.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 docs/reference.md diff --git a/README.md b/README.md index 8bc448c..bf39d71 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/reference.md b/docs/reference.md new file mode 100644 index 0000000..46ae377 --- /dev/null +++ b/docs/reference.md @@ -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 | |