From 2908d6d987078e094993e8f24ce5047c859a2cf6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Wed, 20 Nov 2024 23:49:45 +0200 Subject: [PATCH] docs(ref): Document config defaults Some description tweaks while at it. --- docs/reference.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/reference.md b/docs/reference.md index b3a7dae..4227c65 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -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.\.\ | \ | \ | See `default.` for child keys. Run with `--type-list` to see available ``s | -| type.\.extend-glob | \- | list of strings | File globs for matching `` | +| 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.\.\ | \ | \ | \ | See `default.` for child keys. Run with `--type-list` to see available ``s. | +| type.\.extend-glob | \- | list of strings | \- | File globs for matching ``. | Common `extend-ignore-re`: - Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"`