Add Codespell job to GitHub Actions (#571) #573
Conversation
KyleFromKitware
force-pushed
the
codespell
branch
9 times, most recently
from
e173735 to
8486aad
Compare
.codespellrc
Outdated
| # Disable warnings about binary files | ||
| quiet-level = 2 | ||
| skip = */.git,*/common_tools/cloc | ||
| ignore-words-list = thur,inout,te,nd,lod,aci,nin,nnumber,wile,reall,somwhere |
There was a problem hiding this comment.
@gsjaardema In commit e8a48b3, you restored a number of email addresses to somwhere.com. Could you please explain the motivation for that?
There was a problem hiding this comment.
I think I had changed them in a previous commit and then decided that this correction wasn't necessarily a spelling error since maybe somwhere.com is as valid as somewhere.com as an email address/domain name. Similar to not changing bogous to bogus -- maybe was intentionally not a valid word...
There was a problem hiding this comment.
It may be a valid domain name, but I think the intention was clearly somewhere.com. I think we should fix it. @bartlettroscoe WDYT?
There was a problem hiding this comment.
Where is somwhere flagged? I don't think that is valid name.
There was a problem hiding this comment.
This is fixed in commit d898491 (#573).
KyleFromKitware
force-pushed
the
codespell
branch
from
8e860c3 to
52081e1
Compare
KyleFromKitware
changed the title
KyleFromKitware
force-pushed
the
codespell
branch
from
52081e1 to
b80da9d
Compare
There was a problem hiding this comment.
I just want to make sure this is set up so it can be run locally as well. I would really like to have a TriBITS ctest test that runs the spell checking as part of the test suite (if codespell is available).
Also, it would be great to put in a commit hook that runs codespell on files modified in a commit (if codespell is installed locally).
bartlettroscoe
added
type: enhancement
component: testing
bartlettroscoe
changed the title
bartlettroscoe
force-pushed
the
codespell
branch
from
14d3ab6 to
d500024
Compare
…BITSPub#571) While running codespell 2.2.1, it flagged 'n{nothing}Does' in: #print("\n{nothing}Does ...") which is not a misspelling (and a later version of codespell does not flag this) but I wanted to remove it since it was not really being used. And while I was at it, I remove all of the commented out print() statements (since those were just there for debugging).
These really should be deleted since we don't maintain bare clones anymore, and if we did, we could not care about these hooks. I did this as part of TriBITSPub#571.
I also added a bash script to automate installing the git hook scripts with printed messages.
bartlettroscoe
force-pushed
the
codespell
branch
from
d500024 to
38a3bed
Compare
There was a problem hiding this comment.
All of the changes look good to me added by @KyleFromKitware. I have added a local CTest test TriBITS_codespell that is defined and runs locally when the 'codespell' command is present. Also, I added a Git commit-msg hook that runs codespell on the commit message string itself.
We can still add a Git pre-commit hook that runs codespell before every commit but I think that may be overkill since there is a local CTest test that runs it. Also, I have found that codespell missing a lot of misspelling so having the codespell test fail locally is a good reminder to go back into the modified files and look for any other misspelling using flyspell under emacs.
Addresses #571