add codespell: config, workflow and have typos fixed #770
Conversation
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
|
@yarikoptic Thanks for the suggestion. I am worried about the "fixing typo automagically" on the first round. There are a number of items where a spell check change would be unfortunate. I haven't used this before. Is there a way to not do the automagically on the first round to see where the dust falls? I'd like to put this on all our repos. |
|
It doesn't fix anything automatically unless you ask it. Workflow just fails if typo is added, then you fix it or add to skips in configuration and continue |
|
Here is the adhoc script https://github.com/yarikoptic/improveit/blob/main/codespellit I used to add codespell here. I guess it could be organization wide workflow which would just check if project has codespell config to proceed, and then each repo would need similar pr fixing initial set of typos |
|
@yarikoptic unfortunately we're going to have to revert all of the codespell related commits as they changed the hed schema files which must not be changed regardless of typos. I didn't notice it until I did the merges and then @IanCa pointed it out. This is going to take some work to do all of the proper excludes. |
|
It is easy to exclude files. What files should I exclude? |
|
I need to revert all of the merges for all repos first since the HED schema
files were changed in all of them (I should have noticed -- sorry).
We will need to exclude all .xml files and all .mediawiki files except
those in a prerelease subdirectory. Let me revert everything first, then
maybe you would be willing to do the modifications? Thanks
…On Mon, Oct 2, 2023 at 11:53 AM Yaroslav Halchenko ***@***.***> wrote:
It is easy to exclude files. What files should I exclude?
—
Reply to this email directly, view it on GitHub
<#770 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAJCJOWHQO7PTNWRW44ZAFDX5LWP7AVCNFSM6AAAAAA5AEJADOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBTGM4TAMRXGE>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
@yarikoptic - we fixed some of the exclusions and put your suggestions in another PR. Thx. |
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