Add codespell support (config, workflow to detect/not fix) and make it fix some typos#1071
Add codespell support (config, workflow to detect/not fix) and make it fix some typos#1071yarikoptic wants to merge 5 commits intopaperwm:developfrom
Conversation
|
should I rebase into PS FWIW, in some projects we eventually switched everywhere default branches to be the ones to seek PRs into to avoid hassle of needing to ask to rebase etc. Should may be |
|
Yes, all PRs should go to I wasn't involved with the decision to set up the branches how they are now (See CONTRIBUTING.md for history (it's short)). But We could probably do a better job of handling the install process (I'd guide people to use the |
e34c334 to
3a92e69
Compare
Automated fixes applied by codespell -w.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
=== Do not change lines below ===
{
"chain": [],
"cmd": "uvx codespell -w",
"exit": 65,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Fixed typos that codespell detected but didn't auto-fix: - extact → extract (extract all mods) - initate → initiate (initiate visual destruction) - troube → trouble (is trouble) - essentiall → essentially (essentially disable) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
3a92e69 to
1e78016
Compare
|
re-based etc, might be ready for the prime time! ;-) |
Thesola10
left a comment
There was a problem hiding this comment.
Looks ready for prime time
|
|
||
| # generated disk image for test VM | ||
| nixos.qcow2 | ||
| .claude/ |
There was a problem hiding this comment.
want me to filter it out?
| check-hidden = true | ||
| # ignore-regex = | ||
| # initialY: variable name for initial Y coordinate | ||
| ignore-words-list = easer,positionOf,initialY |
There was a problem hiding this comment.
good idea, but codespell-project/codespell#196 still not being implemented gives me pause as to the quality of codespell itself...
There was a problem hiding this comment.
oh, if that was the only concern... all software is constant WiP / trove of skeletons etc... only visidata (or replace with paperwm if you like) is perfect! ;)
There was a problem hiding this comment.
FWIW -- I used codespell across HUNDREDS of projects with good return rate... here is some overview of state of my endavors on that end if you like to see more 'victims' of typos-less world of mine: https://github.com/yarikoptic/improveit-dashboard/blob/master/READMEs/yarikoptic.md
More about codespell: https://github.com/codespell-project/codespell .
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.