actions/typos
0
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2026-10-17 09:35:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1186 from friday/patch-1

Browse Source 
docs: add linkable header to example configurations
This commit is contained in:
Ed Page
2024-12-19 16:28:57 -06:00
committed by GitHub
parent 9d89015957 e7ed6e87f8
commit 6559554303
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference.md
+2
View File
@@ -39,6 +39,8 @@ Configuration is read from the following (in precedence order)
| 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>`. |
### Example configurations
Common `extend-ignore-re`:
- Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"`
- Line block with `# spellchecker:<on|off>`: `"(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"`