Skip to content

Commit

Permalink
Merge pull request #1153 from scop/docs/config-defaults
Browse files Browse the repository at this point in the history 
docs(ref): Document config defaults
  • Loading branch information
@epage
epage authored Nov 20, 2024
2 parents ba61bb6 + 2908d6d commit f468223
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions docs/reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,29 @@ Configuration is read from the following (in precedence order)

### Config Fields

| Field | Argument | Format | Description |
|------------------------|-------------------|--------|-------------|
| files.binary | --binary | bool | Check binary files as text |
| files.extend-exclude | --exclude | list of strings | Typos-specific ignore globs (gitignore syntax) |
| \- | --force-exclude | bool | Respect excluded files even for paths passed explicitly. |
| 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.binary | --binary | bool | Check binary files as text |
| default.check-filename | \- | bool | Verifying spelling in file names. |
| default.check-file | \- | bool | Verifying spelling in files. |
| default.unicode | --unicode | bool | Allow unicode characters in identifiers (and not just ASCII) |
| default.locale | --locale | en, en-us, en-gb, en-ca, en-au | English dialect to correct to. |
| default.extend-ignore-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | Custom uncorrectable sections (e.g. markdown code fences, PGP signatures, etc) |
| default.extend-identifiers | \- | table of strings | Corrections for [identifiers](./design.md#identifiers-and-words). When the correction is blank, the identifier is never valid. When the correction is the key, the identifier is always valid. |
| default.extend-ignore-identifiers-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | Pattern-match always-valid identifiers |
| default.extend-words | \- | table of strings | Corrections for [words](./design.md#identifiers-and-words). When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
| default.extend-ignore-words-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | Pattern-match always-valid words. Note: you must handle case insensitivity yourself |
| type.\<name>.\<field> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s |
| type.\<name>.extend-glob | \- | list of strings | File globs for matching `<name>` |
| Field | Argument | Format | Default | Description |
|------------------------|-------------------|--------|---------|-------------|
| files.binary | --binary | bool | false | Check binary files as text. |
| files.extend-exclude | --exclude | list of strings | \- | Typos-specific ignore globs (gitignore syntax). |
| \- | --force-exclude | bool | false | Respect excluded files even for paths passed explicitly. |
| files.ignore-hidden | --hidden | bool | true | Skip hidden files and directories. |
| files.ignore-files | --ignore | bool | true | Respect ignore files. |
| files.ignore-dot | --ignore-dot | bool | true | Respect .ignore files. |
| files.ignore-vcs | --ignore-vcs | bool | true | Respect ignore files in vcs directories. |
| files.ignore-global | --ignore-global | bool | true | Respect global ignore files. |
| files.ignore-parent | --ignore-parent | bool | true | Respect ignore files in parent directories. |
| default.binary | --binary | bool | false | Check binary files as text. |
| default.check-filename | \- | bool | true | Verify spelling in file names. |
| default.check-file | \- | bool | true | Verify spelling in files. |
| default.unicode | --unicode | bool | true | Allow unicode characters in identifiers (and not just ASCII). |
| default.locale | --locale | en, en-us, en-gb, en-ca, en-au | en | English dialect to correct to. |
| default.extend-ignore-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | \- | Custom uncorrectable sections (e.g. markdown code fences, PGP signatures, etc) |
| default.extend-identifiers | \- | table of strings | \- | Corrections for [identifiers](./design.md#identifiers-and-words). When the correction is blank, the identifier is never valid. When the correction is the key, the identifier is always valid. |
| default.extend-ignore-identifiers-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | \- | Pattern-match always-valid identifiers. |
| default.extend-words | \- | table of strings | \- | Corrections for [words](./design.md#identifiers-and-words). When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
| default.extend-ignore-words-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | \- | Pattern-match always-valid words. Note: you must handle case insensitivity yourself. |
| type.\<name>.\<field> | \<varied> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s. |
| type.\<name>.extend-glob | \- | list of strings | \- | File globs for matching `<name>`. |

Common `extend-ignore-re`:
- Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"`
Expand Down

0 comments on commit f468223

Please sign in to comment.