usrse.github.io icon indicating copy to clipboard operation
usrse.github.io copied to clipboard

Add codespell: config, github workflow + make it fix some typos

Open yarikoptic opened this issue 1 year ago • 6 comments

Description

I am on the quest to make the world the typo free place ;)

Workflow would just detect typos, not fix them

Checklist:

  • [x] I have previewed changes locally or with CircleCI (runs when PR is created)
  • [x] ~~I have completed any content reviews, such as getting input from relevant working groups. If no, please note this and wait to post the PR to the #website channel until the content has been settled.~~ -- i do not think it is applicable
  • [x] When you are ready for a technical review/merge, post the for the link for the PR in the US-RSE Slack (#website) to ask for reviewers.

yarikoptic avatar Feb 16 '24 16:02 yarikoptic

image

yarikoptic avatar Feb 19 '24 15:02 yarikoptic

@yarikoptic - We do have spell-checking enabled already (see https://github.com/USRSE/usrse.github.io/blob/main/.github/workflows/linting.yaml#L17). Why should we switch to this one?

mrmundt avatar Feb 19 '24 15:02 mrmundt

oh right ! and that is the one which uses codespell dictionary. It is strange then (worth investigation by someone interested) why codespell found a good number of typos for me? Should I just remove codespell config/action and keep PR only with typo fixes?

if someone approves CI run, we might see/compare both

yarikoptic avatar Feb 19 '24 18:02 yarikoptic

It is strange then (worth investigation by someone interested) why codespell found a good number of typos for me?

Could it be because the files input is (mis-)specified as a space-separated list instead of comma-separated?

    - name: Check Spelling
      uses: crate-ci/typos@master # we should really incorporate all new changes
      with:
        files: ./_posts ./pages ./README.md
        config: ./.github/workflows/typo_config.toml

crd477 avatar Feb 21 '24 16:02 crd477

dunno -- not familiar with typos although did see it used... or may be it should be a list here?

yarikoptic avatar Feb 22 '24 03:02 yarikoptic

It's not the spaces. I checked the workflow logs and even tested it out in my own container, and it runs as specified despite not finding the actual typos. Weird. I'd like to keep digging a bit more.

crd477 avatar Feb 22 '24 13:02 crd477

Closing - we have a spell checker tool already.

mrmundt avatar Sep 09 '24 13:09 mrmundt

One thing that this PR illustrated is that ./_events should be added to the files: parameter in .github/workflows/linting.yaml:20.

That addition diagnosed two true positive typos that are still in place in main at this time.

crd477 avatar Sep 09 '24 14:09 crd477