diff options
| author | Josh Soref <2119212+jsoref@users.noreply.github.com> | 2021-12-02 06:17:00 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-02 12:17:00 +0100 |
| commit | 841f3cb0bb7663fa1062ffc59acb7b4581dc1d0f (patch) | |
| tree | a6d2d6471c5bc330281986a3b24eae6a6fde44eb /.github/actions/spelling/README.md | |
| parent | 46e63340eef243f25890e2178931919125c58aae (diff) | |
| download | zsh-841f3cb0bb7663fa1062ffc59acb7b4581dc1d0f.tar.gz zsh-841f3cb0bb7663fa1062ffc59acb7b4581dc1d0f.tar.bz2 zsh-841f3cb0bb7663fa1062ffc59acb7b4581dc1d0f.zip | |
ci: add `check-spelling` action (#10470)
Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
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..dcd237ba2 --- /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. |