Using typos-cli
to catch typos + fixes for existing typos
#2018
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1929
typos-cli
is a tool I have used in the past to automatically catch typos. Feel free to checkout the details here https://github.com/crate-ci/typosIn addition to running this as part of the CI, I do want users the ability to check the typos as well on their local dev setup, so, I provided the
just spellcheck
. A small note is that we have to installtypos-cli
. Since this is installed using thecargo
, I went ahead to addjust dev-prepare
where we install the tool usingcargo
. Since we assume the users should already setup cargo and rust for their dev environment,cargo
should make this process OS agnostic. In the future, this recipe can be used to install tools such ascargo-bloat
orcargo-udep
and etc.For CI, the github action takes care of setting the cli up and checking.