Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using typos-cli to catch typos + fixes for existing typos #2018

Merged
merged 6 commits into from Jun 8, 2023

Conversation

yihuaf
Copy link
Collaborator

@yihuaf yihuaf commented Jun 7, 2023

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/typos

In 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 install typos-cli. Since this is installed using the cargo, I went ahead to add just dev-prepare where we install the tool using cargo. 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 as cargo-bloat or cargo-udep and etc.

For CI, the github action takes care of setting the cli up and checking.

Signed-off-by: yihuaf <yihuaf@unkies.org>
Signed-off-by: yihuaf <yihuaf@unkies.org>
Signed-off-by: yihuaf <yihuaf@unkies.org>
@yihuaf yihuaf marked this pull request as ready for review June 7, 2023 06:02
@yihuaf yihuaf self-assigned this Jun 7, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jun 7, 2023

Codecov Report

Merging #2018 (7e077d4) into main (67311c8) will not change coverage.
The diff coverage is 50.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2018   +/-   ##
=======================================
  Coverage   64.89%   64.89%           
=======================================
  Files         129      129           
  Lines       14802    14802           
=======================================
  Hits         9606     9606           
  Misses       5196     5196           

Signed-off-by: yihuaf <yihuaf@unkies.org>
Signed-off-by: yihuaf <yihuaf@unkies.org>
Signed-off-by: yihuaf <yihuaf@unkies.org>
@yihuaf yihuaf requested a review from YJDoc2 June 7, 2023 06:31
Copy link
Collaborator

@YJDoc2 YJDoc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm 👍
Thanks a lot!

@YJDoc2 YJDoc2 merged commit 3a790df into containers:main Jun 8, 2023
11 checks passed
@yihuaf yihuaf deleted the yihuaf/typos branch June 13, 2023 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Investigate the use of typos to automatically catch all the typos.
3 participants