typos/docs/reference.md

# `typos` Reference

## Configuration

### Sources

Configuration is read from the following (in precedence order)

- Command line arguments
- File specified via `--config PATH`
- Search parents of specified file / directory for one of `typos.toml`, `_typos.toml`, or `.typos.toml`

### Config Fields

| Field                  | Argument          | Format | Description |
|------------------------|-------------------|--------|-------------|
| files.binary           | --binary          | bool   | Check binary files as text |
| 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. |
| default.locale         | \-                | en, en-us, en-gb, en-ca, en-au   | English dialect to correct to. |
| default.extend-identifiers | \-            | table of strings | Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
| default.extend-words       | \-            | table of strings | Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
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`
feat(config): Allow separating config from source 2020-10-30 09:33:43 -04:00			- Search parents of specified file / directory for one of `typos.toml`, `_typos.toml`, or `.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 \|`
			`\| 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. \|`
feat: Custom dictionary support Switching `valid-` to just `` where you map typo to correction, with support for always-valid and never-valid. Fixes #9 2020-10-24 22:17:16 -04:00			`\| default.extend-identifiers \| \- \| table of strings \| Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. \|`
			`\| default.extend-words \| \- \| table of strings \| Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. \|`