Skip to content

Conversation

harilvfs
Copy link
Contributor

@harilvfs harilvfs commented Jul 8, 2025

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

  • Improved
  • Bug Fixes
  • Feature
  • Documentation
  • Other

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:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my code.
  • I have commented on my code, particularly in hard-to-understand areas.
  • My changes do not introduce new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes.

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.

typos.toml
capitaliseUsername for this one, i also have ignored that too. btw this is in sddm/theme.conf (i guess).
capitalise is not correct in english dictionary, so it will fail, but the config has capitalise by default, so we can't do anything other than ignoring it. so that is also sorted.

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.

@mylinuxforwork
Copy link
Owner

Thank you. The typos will be checked in the docs folder only, right? Means only for the vitepress documents?

@harilvfs
Copy link
Contributor Author

harilvfs commented Jul 8, 2025

no! it check the whole repo

@mylinuxforwork
Copy link
Owner

Which file types? only .md files?

@harilvfs
Copy link
Contributor Author

harilvfs commented Jul 8, 2025

this checks each and every file in the repo markdown, .sh, or any other kind. if it finds any spelling mistake anywhere, the ci will fail, and you can check what is wrong by reviewing the details in the action workflow.

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.

@mylinuxforwork
Copy link
Owner

Thanks for your feedback. I will check this PR later.

@harilvfs
Copy link
Contributor Author

harilvfs commented Jul 24, 2025

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

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.

2 participants