diff options
| author | Marc Cornellà <hello@mcornella.com> | 2021-12-01 12:18:32 +0100 |
|---|---|---|
| committer | Marc Cornellà <hello@mcornella.com> | 2021-12-01 12:20:46 +0100 |
| commit | aef393bdce523ed5e5754721965fab2da8080119 (patch) | |
| tree | 5f7657dcd9048454bc91ced07128c0b47eb60955 /.github/actions/spelling/README.md | |
| parent | 0e41181d547e2f89ffc503a7afc8b0f3991dd1a8 (diff) | |
| download | zsh-aef393bdce523ed5e5754721965fab2da8080119.tar.gz zsh-aef393bdce523ed5e5754721965fab2da8080119.tar.bz2 zsh-aef393bdce523ed5e5754721965fab2da8080119.zip | |
ci: add `check-spelling` GitHub Action
Diffstat (limited to '.github/actions/spelling/README.md')
| -rw-r--r-- | .github/actions/spelling/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md new file mode 100644 index 000000000..1bd7d4412 --- /dev/null +++ b/.github/actions/spelling/README.md @@ -0,0 +1,15 @@ +# check-spelling/check-spelling configuration + +| File | Purpose | Format | Info | +| -------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| [dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary) | +| [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) | +| [reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) | +| [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) | +| [only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) | +| [patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) | +| [expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) | +| [advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) | + +Note: you can replace any of these files with a directory by the same name (minus the suffix) +and then include multiple files inside that directory (with that suffix) to merge multiple files together. |