Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix a typo #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 22, 2025

Conversation

yarikoptic
Copy link
Contributor

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.

I eyeball the hits, there is even a fix to a URL to become proper; the more eyes the merrier.

…(but ignoring overall fail due to ambigous ones)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 5",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@laramiel
Copy link
Collaborator

Thanks for the cleanups. I can apply the spelling fixes soon, but will hold off on the automation since we need to figure out how to run it internally as well.

@copybara-service copybara-service bot merged commit 279df3a into google:master Apr 22, 2025
1 check passed
@yarikoptic
Copy link
Contributor Author

locally -- just pip install codespell (or via anything else) and call codespell. Some folks add to pre-commit when they use that, e.g. like we in https://github.com/dandi/dandi-cli/blob/master/.pre-commit-config.yaml#L21

@laramiel
Copy link
Collaborator

Do you know if there are existing Bazel codespell macros? It would make integration pretty easy if we could run it as a bazel test.

@yarikoptic
Copy link
Contributor Author

sorry , not familiar with bazel. Nothing 100% obvious with quick google search came up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants