terminal/.github/actions/spelling/patterns
Josh Soref bbe8275f69
ci: spelling: update to v0.0.18 (#10035)
Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>

<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
## Summary of the Pull Request

Upgrade check-spelling to [v0.0.18](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.18)

<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? --> 
## References

<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [ ] Closes #xxx
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx
* [ ] Schema updated.
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx

<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
## Detailed Description of the Pull Request / Additional comments

I've replaced the `dictionary` directory with `allow` and `reject`. When terminal got check-spelling, I didn't have a way to do `allow`/`reject` (but they were added a while ago). With this release, the bot will complain about items that are in user managed files that wouldn't be valid, this is mostly `-`s in dictionary files, but it also includes numbers `0`..`9` and `_`. If a specific token needs to be accepted but not its sub-elements, the item should be added to `patterns.txt` instead  (`D2DERR_SHADER_COMPILE_FAILED` is an example).

With this version, check-spelling defaults to only considering tokens with at least 3 letters. It's possible to tune it back to 2 (or even 1), but in testing, the 2 character tokens have ended up not being worthwhile.  (This can be [adjusted](https://github.com/check-spelling/check-spelling/wiki/Configuration#shortest_word) if it turns out that people manage to misspell two character tokens often enough to justify checking them.)

<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
## Validation Steps Performed

I ran a number of passes of the spell checker in https://github.com/check-spelling/terminal/actions (note: I tend to delete this repository, so this link may be dead at some point, and action run logs expire).
2021-05-14 08:28:37 -05:00
..
0_n.txt ci: update to Spell check to 0.0.17a (#9014) 2021-02-03 11:17:38 -08:00
0_r.txt ci: update to Spell check to 0.0.17a (#9014) 2021-02-03 11:17:38 -08:00
0_t.txt ci: update to Spell check to 0.0.17a (#9014) 2021-02-03 11:17:38 -08:00
patterns.txt ci: spelling: update to v0.0.18 (#10035) 2021-05-14 08:28:37 -05:00
README.md ci: update to Spell check to 0.0.17a (#9014) 2021-02-03 11:17:38 -08:00

The contents of each .txt file in this directory are merged together. Each line is a Perl 5 regular expression. Nothing is guaranteed about the order in which they're merged. -- If this is a problem, please reach out.

Note: order of the contents of these files can matter. Lines from an individual file are handled in file order. Files are selected in alphabetical order.

  • n, r, and t are specifically to work around a quirk in the spell checker: it often sees C strings of the form "Hello\nwerld". And would prefer to spot the typo of werld.
  • patterns is the main list -- there is nothing particularly special about the file name (beyond the extension which is important).