Skip to content

Fix a few typos & add CI #7533

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

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Conversation

jacksongoode
Copy link

@jacksongoode jacksongoode commented Apr 12, 2025

I noticed there were a few typos and wanted to address them, but think a GitHub Action workflow would likely be better.

This fixes a few typos and adds a typo linter for functions and text within the project. The last commit shows the changes that were made with typos --exclude "*.min.*" --write-changes.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 12, 2025
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Apr 12, 2025
@blu3berryys
Copy link

It looks good, but I think you should make a seperate workflow for the spell checker aswell.

@blu3berryys
Copy link

Also you can change crate-ci/[email protected] to crate-ci/typos@v1 I think (so we don't need to bump it everytime)

@blu3berryys
Copy link

Proably a bad idea but, when you make this into a seperate workflow, we can make it run weekly or daily (?) and commit them using another action. So we don't need run it manually.

@jacksongoode
Copy link
Author

Proably a bad idea but, when you make this into a seperate workflow, we can make it run weekly or daily (?) and commit them using another action. So we don't need run it manually.

I wouldn't generally let a typo corrector make direct changes - it might mess up and the code would be invalidated. I'd just use this like a linter where corrections are still manually advised.

@blu3berryys
Copy link

Or make it create a PR maybe?

@jacksongoode
Copy link
Author

Yeah, I'd like to hear what @mauro-balades thinks would be the easiest integration of this tool.

@mauro-balades
Copy link
Member

Have you tested everything works as expected?

@jacksongoode
Copy link
Author

Given that all of these changes are non-functional and just cosmetic - I would imagine everything would work. I can build it myself and attempt to test, but I doubt there would be direct issues related to this.

@mauro-balades
Copy link
Member

Ill take a look once I have time, but I for one, never had a good experience with these tools

@blu3berryys
Copy link

Lol

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants