GitHub Action to discover typos with codespell

[cclauss]

https://pypi.org/project/codespell

Test results: https://github.com/cclauss/jython.github.io/actions

2
./jython.github.io/registry.md:7: envrionment ==> environment
./jython.github.io/registry.md:11: formated ==> formatted

[shdwkl]

Inspiring, i'll Start every project of mine with that action in it...

[jeff5]

Seems reasonable to me. Thanks.

[jeff5]

@cclauss : I expected this to run when merged, but it didn't. Am I missing something?

[cclauss]

Seems like it ran here https://github.com/jython/jython.github.io/actions/workflows/codespell.yml

[jeff5]

If it runs on subsequent pushes and PRs, that's fine. I was obviously wrong to expect it to run on the commit that adds it.

codespell takes the interesting approach of trying to catalogue misspellings, rather than using a dictionary of correctly spelled words. If not 100% successful, it makes a change for the errors to be mostly in the other direction (not constantly complaining about English spellings or words it doesn't know).

I'll also look at jython/jython#179.

[cclauss]

Codespell is good at off-by-one typos like one missing letter or two transposed letters but it is certainly not a full spellchecker. The upside is that it is astoundingly fast even on a massive repo of text.