Add codespell: config + workflow to detect new typos. Get some typos fixed #9234
Conversation
|
Please rebase because pre-commit should be fixed now. Also, |
yarikoptic
force-pushed
the
enh-codespell
branch
3 times, most recently
from
0b28a9f
to
726d43d
Compare
.codespellrc
Outdated
| # Ref: https://github.com/codespell-project/codespell#using-a-config-file | ||
| [codespell] | ||
| skip = .git,*.svg,*.css,*.min.*,*-min.js,.codespellrc,locale,static,kickstarter-announcement.md | ||
| check-hidden = true |
There was a problem hiding this comment.
check-hidden is not a good idea on a GitHub repo because it will spellcheck all our dependencies and a bunch of other files that we don't have the desire or ability to modify. If we remove that option then we can simplify to:
codespell --ignore-words-list=fo,malcom,ser --skip="*/kickstarter-announcement.md,*.js,*.map,*.po"
Also, this project already has a setup.cfg file so perhaps it would be better to put this configuration there.
This has the added advantage that it will be automatically migrated to pyproject.toml by tools like ini2toml.
There was a problem hiding this comment.
- moved configuration to
setup.cfg(yet to adjust my https://github.com/yarikoptic/improveit/blob/main/codespellit to do so automagically -- it only considers pyproject.toml ATM) - minimized to your recommendation/liking
- dropped added workflow entirely -- with pre-commit workflow you don't need it separately (checked that pre-commit workflow did pickup newly added typo)
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2 ./docs/community/release-notes.md",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Known issue -- yet to be addressed: codespell-project/codespell#3196
yarikoptic
force-pushed
the
enh-codespell
branch
from
5fc277b
to
fcfac9f
Compare
|
Is this still a Draft or Ready to be reviewed? |
|
sorry, forgot to bring it back. Ready now |
|
thanks |
Description
https://github.com/codespell-project/codespell is great at fixing known typos. I am proposing codespell to any project I get to look "inside" at