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

[FEAT]: Add CI workflow to check for commonly misspelled words #376

Merged
merged 15 commits into from
Jan 22, 2024

Conversation

gmacario
Copy link
Member

@gmacario gmacario commented Jan 22, 2024

📑 Description

On every push, pull request, and periodically, use codespell to check for commonly misspelled words.

In the event of a false positive, the problematic word should be added, in all lowercase, to the field of . Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore list. The ignore list is comma-separated with no spaces.

Based upon https://github.com/arduino/meta-partner-arduino/tree/main/.github/workflows

See arduino/meta-partner-arduino#26

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

ℹ Additional Information

@gmacario gmacario self-assigned this Jan 22, 2024
@gmacario gmacario added the enhancement New feature or request label Jan 22, 2024
@gmacario gmacario changed the title [FEAT] .github/workflows: Add spell-check.yml (WIP) [FEAT] Add CI workflow to check for commonly misspelled words Jan 22, 2024
@gmacario gmacario changed the title (WIP) [FEAT] Add CI workflow to check for commonly misspelled words (WIP) [FEAT]: Add CI workflow to check for commonly misspelled words Jan 22, 2024
@gmacario
Copy link
Member Author

It looks like the remaining errors reported by spellcheck are true positives.

Excerpt from https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376

Running codespell on '' with the following options...
Check filenames? ''
Check hidden? ''
Exclude file ''
Skipping './.git'
Builtin dictionaries ''
Ignore words file ''
Ignore words list ''
Ignore URI words list ''
Resulting CLI options  --skip ./.git
Error: ./mocs/studies/README.md:12: avalaible ==> available
Error: ./mocs/studies/camera-support/README.md:3: Technics ==> Techniques
25
Error: ./mocs/project/README.md:12: avalaible ==> available
Error: ./code/poweredupapp-flash-move/README.md:10: Technics ==> Techniques
Error: ./docs/bibliography.md:37: Technics ==> Techniques
Error: ./docs/bibliography.md:47: Technics ==> Techniques
Error: ./docs/arneis-social-media.md:[6](https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376#step:4:7)[7](https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376#step:4:8): Technics ==> Techniques
Error: ./docs/howto/howto-install-raspios64.md:153: usin ==> using
Error: ./docs/howto/howto-install-raspios64.md:192: passowrd ==> password
Error: ./docs/howto/howto-prepare-rpi4b-for-arneis.md:77: usin ==> using
Error: ./docs/howto/howto-prepare-rpi4b-for-arneis.md:116: passowrd ==> password
Error: ./docs/howto/howto-use-rclone-with-cubbit-ds3.md:327: compre ==> compare, compère
Error: ./docs/howto/howto-install-k3s-for-arneis.md:927: Uniqu ==> Unique
Error: ./docs/howto/howto-install-micropython-nano33ble.md:63: modifiying ==> modifying
Error: ./docs/howto/howto-install-depthai-on-rpi.md:[8](https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376#step:4:9)3: displyed ==> displayed
Error: ./docs/howto/howto-control-rpi-poweredup.md:74: succesful ==> successful
Error: ./docs/howto/howto-control-rpi-poweredup.md:[9](https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376#step:4:10)8: Technics ==> Techniques
Error: ./docs/howto/howto-control-rpi-poweredup.md:206: Technics ==> Techniques
Error: ./docs/howto/howto-control-rpi-poweredup.md:2[16](https://github.com/B-AROL-O/ARNEIS/actions/runs/7612599207/job/20730560239?pr=376#step:4:17): Technics ==> Techniques
Error: ./docs/howto/howto-control-rpi-poweredup.md:224: Technics ==> Techniques
Error: ./docs/howto/howto-configure-google-analytics.md:5: followint ==> following
Error: ./docs/howto/howto-configure-google-analytics.md:32: visualisations ==> visualizations
Error: ./docs/howto/howto-train-deploy-NN.md:55: adviced ==> advised
Error: ./docs/howto/howto-train-deploy-NN.md:76: cointains ==> contains
Error: ./docs/architecture/arneis-swarch.md:46: Technics ==> Techniques
Codespell found one or more problems

CC: @alv67, @gteti

@alv67
Copy link
Member

alv67 commented Jan 22, 2024

Mine only typo is "avalaible" all other are from @gmacario and @gteti .
Since I'm a good boy I fixed some of yours too.
All "Technics" are not typos, I tried to disable that with different editing on spell-check.yml configuration.

@gmacario is up to you fix the :

Error: ./docs/howto/howto-use-rclone-with-cubbit-ds3.md:327: compre ==> compare, compère
Error: ./docs/howto/howto-install-k3s-for-arneis.md:927: Uniqu ==> Unique

those are not typos, please check by yourself.

@gmacario
Copy link
Member Author

Thanks @alv67 for your contribution.

Mine only typo is "avalaible" all other are from @gmacario and @gteti .
Since I'm a good boy I fixed some of yours too.
All "Technics" are not typos,

AFAIK "Technic" is a correct word (and already whitelisted in toplevel .codespellrc) while "Technics" is not.
Please see https://www.lego.com/it-it/themes/technic

I tried to disable that with different editing on spell-check.yml configuration.

AFAIK the config file to be used is .codespellrc

@gmacario is up to you fix the :

Error: ./docs/howto/howto-use-rclone-with-cubbit-ds3.md:327: compre ==> compare, compère
Error: ./docs/howto/howto-install-k3s-for-arneis.md:927: Uniqu ==> Unique

those are not typos, please check by yourself.

OK, will have a look

@gmacario gmacario changed the title (WIP) [FEAT]: Add CI workflow to check for commonly misspelled words [FEAT]: Add CI workflow to check for commonly misspelled words Jan 22, 2024
@gmacario gmacario requested a review from alv67 January 22, 2024 20:50
@gmacario
Copy link
Member Author

Everything should be fixed now.
@alv67 please review and merge if you agree.

@gmacario gmacario merged commit 73e5534 into main Jan 22, 2024
11 checks passed
@gmacario gmacario deleted the gmacario-add-spell-check branch January 22, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants