Add codespell support (config, workflow to detect/not fix) and make it fix few typos#492
Add codespell support (config, workflow to detect/not fix) and make it fix few typos#492yarikoptic wants to merge 3 commits intojupyterhub:mainfrom
Conversation
|
Is it possible to use codespell with just pre-commit, so we don't need another GitHub workflow? |
yes
if we remove workflow - that would be gone - but it would just remove that convenience. |
|
We can deal with enforcing pre-commit in #489 I think keeping things simple and using just pre-commit is best, especially as typos should be infrequent after an initial review of the repo. |
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
yarikoptic
force-pushed
the
enh-codespell
branch
from
62dbb7d to
b381a39
Compare
|
Coolio, your call, rebased kicking away action and the TEMP commit with a typo, took out of draft. |
manics
left a comment
manics
left a comment
There was a problem hiding this comment.
Thanks. Ignore the pre-commit failure since it's due to pre-exisitng formatting issues, codespell is passing.
| # Ref: https://github.com/codespell-project/codespell#using-a-config-file | ||
| skip = '.git*,*.svg,*.lock' | ||
| check-hidden = true | ||
| ignore-regex = '\bTE\b' |
There was a problem hiding this comment.
Can you add a comment for why this is needed (presumably you've found some intentional use of TE?)
3 participants
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.