-
Notifications
You must be signed in to change notification settings - Fork 281
ci: add typo checker #1019
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
base: main
Are you sure you want to change the base?
ci: add typo checker #1019
Conversation
Thank you. The typos will be checked in the docs folder only, right? Means only for the vitepress documents? |
no! it check the whole repo |
Which file types? only .md files? |
this checks each and every file in the repo basically, for this ci. we haven't define any specific file or path to check, so it will check all the repo files for typos. and this is how we place this checker in the repo. only targeting a specific dir doesn’t make sense. like, a typo mistake can be anywhere. |
Thanks for your feedback. I will check this PR later. |
just see the repo and you have completely changed the repo structure and it looks better now. the conflict has been fixed, now there are only typos workflow and typos.toml for specific use cases. typo is failing due to some typos mistake on docs side. 2025-07-24-20.39.07.082320879.mp4 |
Description
basically i have added a ci/cd action workflow for typo checker. you can see the typochecker repo https://github.com/crate-ci/typos/.
Changes
Context
this become bit necessary as we somewhere write some mistake typo or misspelling. also as you know we found many typos mistake here. so having a typo checker that run in each commit and check for spelling is far more better and easier also typo free btw.
Checklist
Please ensure your pull request meets the following requirements:
Additional Notes
some key note :
main workflow ci is
typos.yml
. basically it run in each commit also in every open pr's. so if there is any misspelled it will fail and you can see the action workflow details for knowing where it exact fail or where the spell is wrong.we also have
typos.toml
configuration for typos checker. and it is very much needed. somewhere i see some british spell so it is correct spell so i have put it to ignore that specific spell so it doesn't fail. because we have put the locale lang to en_us so it will obviously fail if we do not do that.also
ags
is correct but it will fail because there is no any dictionary name for ags, same for endeavour.and for
dependabot.yml
basically this is a update checker for anything. in this we need for github actions like typos version update. in every typos update there is many dictionary and other word added. so we need update when the creator out the release.basically if there is an update for typos ci
uses: crate-ci/typos@v1.34.0
dependabot will create a pr of that update so we can directly merge no need to manual inspection.
also i fix a lot of typos the typos ci detect.
yeah that much i guess i have cover all the thing
btw my last commit has pass the typos ci test you can see here https://github.com/harilvfs/dotfiles/actions/runs/16137754474
edit: also, can we add this to the dotfiles-installer repo? that would be better.