actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 00:51:11 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
typos/docs/reference.md

35 lines
2.5 KiB
Markdown
Raw Normal View History

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(ignore): Typos=specific ignores We want both CLI and config ignores. The question then is what we make them relative to. I decided to favor CLI with `.`. We'll see how this works out Fixes #134
2021-05-20 21:55:32 -04:00
| files.binary | --binary | bool | Check binary files as text |
| files.extend-exclude | --exclude | list of strings | Typos-specific ignore globs (gitignore syntax) |
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.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. |
fix(config)!: Move binary to file Seems like it would make sense to allow varying this by directory (when supporting layering) and by file type.
2021-01-05 11:35:43 -05:00
| default.binary | --binary | bool | Check binary files as text |
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
| default.check-filename | \- | bool | Verifying spelling in file names. |
| default.check-file | \- | bool | Verifying spelling in files. |
feat(ddi): Allow controlling 'unicode' via args
2021-04-30 11:32:15 -04:00
| default.unicode | --unicode | bool | Allow unicode characters in identifiers (and not just ASCII) |
refactor(config)!: Detect when no dict config In preparing for smarter handling of config, we need to be able to tell what is present and what isn't. BREAKING CHANGE: `--hex` was removed, the value didn't seem high enough.
2021-03-01 21:37:05 -05:00
| default.locale | --locale | en, en-us, en-gb, en-ca, en-au | English dialect to correct to. |
docs(ref): Further clarify identifiers and words This supersedes #648
2023-01-03 08:06:02 -05:00
| 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. |
feat(dict): extend-ignore-identifiers-re support This opens the door for users to provide patterns for identifiers that are always valid. The key limitation is "identifiers". Run `typos --identifiers` to verify what you are trying to write the regex for. Fixes #651
2023-03-17 23:40:55 -04:00
| default.extend-ignore-identifiers-re | \- | list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) | Pattern-match always-valid identifiers |
docs(ref): Further clarify identifiers and words This supersedes #648
2023-01-03 08:06:02 -05:00
| 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. |
docs(reference): Formatting and copy-pasto fixes Escape left angle bracket, fix copy-pastos in default.extend-identifiers and default.extend-words descriptions.
2022-04-10 17:06:26 -04:00
| type.\<name>.\<field> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s |
docs(reference): Fix glob field name
2023-03-18 00:37:57 -04:00
| type.\<name>.extend-glob | \- | list of strings | File globs for matching `<name>` |
Reference in a new issue Copy permalink