-
Notifications
You must be signed in to change notification settings - Fork 507
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
ci: Add spell checker in pre-commit #4859
Conversation
chore: update checkers table
It's not clear to me if this actually addresses #2971 because our current spell checker runs on every word and this seems like it's got more of a typo-specific thing going on, but it seems like it could be a good supplement nonetheless. |
Yeah I guess you are right, I tried with check-spelling but seems to have some docker thing and meanwhile I came across this and thought it would't hurt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alas, I don't know any obvious alternatives, so it's a research project for someone!
Anyhow, this looks like codespell is not failing when we run it, so it's probably safe to try it out on main and see if we find it helpful. Before I merge this, can you put a few lines explaining it into https://github.com/intel/cve-bin-tool/blob/main/CONTRIBUTING.md#running-linters -- just a line explaining what it's for and then a little section explaining how to run it on the command line so people can cut/paste if they want to run it before pre-commit triggers. You can see what the other ones look like there.
I guess this should be good |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor nit with explicitly setting the version number in requirements.txt, but I'll accept my own suggestion and then merge this once the tests are done. Thank you again for your time researching and setting this up!
Thanks @terriko |
Fixes #2971
I added a spell checker to the pre-commit, please test it out and see if it's good, i can update if needed.
Also there are a few spelling mistakes that this is giving me, I'll fix them and raise a pr in a bit
Thanks