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: config, workflow and have typos fixed #4324

Merged
merged 9 commits into from
Oct 5, 2023

Conversation

yarikoptic
Copy link
Contributor

workflow would only detect when a new typo is introduced, it will not automagically inject its fix somehow.

more info on codespell: https://github.com/codespell-project/codespell

@netlify
Copy link

netlify bot commented Sep 20, 2023

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 38d3ba9
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/650b3783f56ee500086193e7

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== 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 ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2 ./modules/nextflow/src/main/groovy/nextflow/trace/TraceRecord.groovy",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
@yarikoptic
Copy link
Contributor Author

I've fixed up for

/home/runner/work/nextflow/nextflow/modules/nextflow/src/test/groovy/nextflow/cli/CmdSecretTest.groovy: 63: Unexpected input: 't' @ line 63, column 41.
> Task :nextflow:compileTestGroovy FAILED
   hould validate #COMMAND doesn't accept #
                                 ^

1 error

@yarikoptic
Copy link
Contributor Author

It is all green and ready for review!

@pditommaso
Copy link
Member

pditommaso commented Sep 26, 2023

Thanks for this PR. Could you please provide more details of the goal of these changes?

@yarikoptic
Copy link
Contributor Author

The goal is to fix and prevent common typos anywhere in the codebase. codespell catches common typos and has proposed ways to fix them -- that is what I have done here. Added workflow would run codespell for any new PR, and error out if PR introduces a new typo, thus alerting author to fix it.

Copy link
Member

@pditommaso pditommaso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks a lot

@pditommaso pditommaso merged commit e044b7a into nextflow-io:master Oct 5, 2023
19 checks passed
abhi18av pushed a commit to abhi18av/nextflow that referenced this pull request Oct 28, 2023

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
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