GitHub Action
Check Spelling
Everyone makes typos. This includes people writing documentation and comments, but it also includes programmers naming variables, functions, APIs, classes, and filenames.
Often, programmers will use InitialCapitalization, camelCase,
ALL_CAPS, or IDLCase when naming their things. When they do this, it makes
it much harder for naive spelling tools to recognize misspellings, and as such,
with a really high false-positive rate, people don't tend to enable spell checking
at all.
This repository's tools are capable of tolerating all of those variations. Specifically, w understands enough about how programmers name things that it can split the above conventions into word-like things for checking against a dictionary.
Just copy the spell-check-this
.github/workflows/spelling.yml into your .github/workflows in your project.
See the documentation for Configuration information.
When check-spelling runs and encounters something that isn't ideal,
it may output a message including an event code,
at the end of the message (unrecognized-spelling).
You should be able to look up the code in
https://docs.check-spelling.dev/Event-descriptions.
For unrecognized-spelling,
that's:
https://docs.check-spelling.dev/Event-descriptions#unrecognized-spelling.
As of v0.0.22, you'll be able to use non English dictionaries with the help of Hunspell.
There is a wiki containing evolving information. It's open to public editing (and is occasionally defaced/spammed).
Yes you can!
- Install Act
act
I do test development on a prerelease branch.
Features and the behavior of this branch are not guaranteed to be stable as they're under semi-active development.