codespell: add config and action to codespell the code to avoid known typos #1006
Conversation
This file contains 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",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
|
thanks I did not know about this tool, does this only check in comments / non-code? I am very wary of any tool that can change actual code (which is why we don't use black) |
Codecov Report
@@ Coverage Diff @@
## main #1006 +/- ##
=======================================
Coverage 58.69% 58.69%
=======================================
Files 40 40
Lines 4551 4551
=======================================
Hits 2671 2671
Misses 1880 1880
|
|
It does check everything, including code. I did have cases of finding/fixing typos in scripts not covered through tests. It doesn't change any code unless you ask it when you run it locally - action just checks |
|
thanks it was helpful to see the typos, but I don't feel comfortable with it being able to change code |
yarikoptic
added a commit
to yarikoptic/suite2p
that referenced
this pull request
Aug 7, 2023
note -- this is just a single commit from a full(er) collection which was proposed in MouseLand#1006 and carried configuration for codespell and also github action. This commit is just typo fixes done by codespell when it had that config. === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^
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.
No description provided.