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 #12

Merged
merged 7 commits into from
Oct 4, 2024

Conversation

yarikoptic
Copy link
Contributor

Blame @Remi-Gau

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.

…(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 ^^^
@paquiteau
Copy link
Owner

Hi thanks for the PR
Codespell will be a great addition indeed.

Any reason to not put it inside the linter workflow (with black and ruff) ?

Otherwise LGTM :)

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Oct 4, 2024

Any reason to not put it inside the linter workflow (with black and ruff) ?

That's because the spell of @yarikoptic sets things in separate workflow by default.

If I am not mistaken this whole PR was created by casting the spell with a single command on his terminal.

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Oct 4, 2024

I can take care to integrate into the linting workflow in a follow up PR.

@yarikoptic
Copy link
Contributor Author

If I am not mistaken this whole PR was created by casting the spell with a single command on his terminal.

Correct. It is this little helper:

happen you would like to cast spells too ;) but if you are really into casting, check those out https://github.com/datalad/screencaster which could make you appear really like a magician while giving life demos -- "typing" commands very fast and without mistakes, while still potentially interactively working in that terminal. @adswa can attest that it brings awe to the audience ;)

@Remi-Gau
Copy link
Collaborator

Remi-Gau commented Oct 4, 2024

if this conversation continues I am going to create a bunch of alias that are harry potter based:

I'll start

accio='git pull'

@paquiteau
Copy link
Owner

Awesome stuff @yarikoptic you truly are a wizard with more mana than me 😅

Let's get done with this though 😊

@paquiteau paquiteau self-requested a review October 4, 2024 16:32
@paquiteau paquiteau merged commit 1bca434 into paquiteau:master Oct 4, 2024
2 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.

3 participants