Add codespell support (config, workflow to detect/not fix) and make it fix some typos #3513
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 4",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
…agically
=== 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
3b035b8 to
706f0f6
Compare
|
Hi yarikoptic, thank you for the PR. :) This is interesting and could prove to be useful for us. I suppose the renaming of variables and existing strings could pose issues though. I might point this at the our |
|
just to make clear: do you want me to rebase/redo these fixes on top of as for variables names etc -- we could whitelist them or annotate inline if only few specific lines, see https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore . Please point which ones you would like? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Inspired by initial attempt in
while listening to a presentation about dmptool.org .