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

use pyspelling as spellchecker #444

Merged
merged 1 commit into from
Jan 4, 2022
Merged

Conversation

blankdots
Copy link
Contributor

@blankdots blankdots commented Dec 31, 2021

Description

this worked really well when introduced in CSCfi/metadata-submitter#316 so we should adopt it.

Related issues

Type of change

  • Refactor spelling CI

Changes Made

  1. add dictionary of files
  2. check docs and all markdown files
  3. adjust some spelling
  4. introduce pyspelling in github action as a improved alternative to misspell which is not that maintained
  5. spellcheck lang.js file for English (1 mistake found)

Testing

  • Tests do not apply

Mentions

I could not figure out the regex how to make it work https://facelessuser.github.io/pyspelling/filters/context/ to filter out just the fi: portion of the lang.js file (fi:((.|\n)*)` worked in other regex testers but not with the pyspelling - would appreciate some help if anyone has any ideas.

@blankdots blankdots added enhancement New feature or request github actions github actions labels Dec 31, 2021
@blankdots blankdots self-assigned this Dec 31, 2021
@csc-felipe
Copy link
Contributor

Did you already run it against the code to see what happens?

@blankdots
Copy link
Contributor Author

Did you already run it against the code to see what happens?

no, not yet, will try next week to see what happens

@csc-felipe
Copy link
Contributor

Should we have the new files without the dot and inside the .github folder, if possible? It would make it more clear that they are only used for GH actions.

@blankdots
Copy link
Contributor Author

Should we have the new files without the dot and inside the .github folder, if possible? It would make it more clear that they are only used for GH actions.

@csc-felipe done

Copy link
Contributor

@csc-felipe csc-felipe left a comment

Choose a reason for hiding this comment

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

LGTM

@blankdots blankdots force-pushed the refactor/spellcheck-action branch from 39ca68c to 0900266 Compare January 4, 2022 13:52
add dictionary of files
check docs and all markdown files
adjust some spelling
ignore Finnish words for spellchecking in lang.js
@blankdots blankdots force-pushed the refactor/spellcheck-action branch from 0900266 to a0b826c Compare January 4, 2022 13:56
@blankdots
Copy link
Contributor Author

merging this as it does not introduce any breaking changes, just spellchecking

@blankdots blankdots merged commit 2ff452b into devel Jan 4, 2022
@blankdots blankdots deleted the refactor/spellcheck-action branch January 4, 2022 14:11
@sampsapenna sampsapenna mentioned this pull request Jan 12, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request github actions github actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants