Skip to content
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

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #267

Merged
merged 9 commits into from
Oct 15, 2024

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Oct 15, 2024

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.

TODOs:

  • remove TEMP commit after verifying that we do or do not need provided custom action

…(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 2",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@paraseba
Copy link
Contributor

I like this! Let's make those checks pass and we can merge. Thank you @yarikoptic !

@yarikoptic
Copy link
Contributor Author

oops -- my absent knowledge of rust -- do not even know how to add a comment correctly, will fix shortly.

But as above single failure showed, you have no run of pre-commit via CI or pre-commit.ci service, so I will keep github action for now.

@yarikoptic yarikoptic marked this pull request as ready for review October 15, 2024 20:35
@paraseba
Copy link
Contributor

Thank you @yarikoptic !

@paraseba paraseba merged commit d2cced7 into earth-mover:main Oct 15, 2024
3 checks passed
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