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

chore: migrate markdown-spellcheck to cspell #1386

Merged
merged 5 commits into from Dec 29, 2019

Conversation

@armano2
Copy link
Member

armano2 commented Dec 28, 2019

Currently used markdown-spellcheck seems to be no longer maintained and uses dictionaries and dependencies that are outdated.

I prepared PR to markdown-spellcheck that fixes issues, updates dictionaries and dependencies lukeapage/node-markdown-spellcheck#135 but so far there is no response from author/maintainers.

Difference between markdown-spellcheck and cspell

markdown-spellcheck can only parse and do spell checking on markdown files. cspell on other hand is used to check spelling in code of any kind, that allowed me to add spellchecking for comments withing ts/js files in project.

Additionally cspell comes with vscode plugin that should improve workflow by showing errors while writing.

New configuration:

Spellchecking uses en-us dictionary with additional support for typescript, software, node, npm, filetypes terms.

Notable changes:

  • Replace outdated package markdown-spellcheck with cspell
  • Enable spellcheck for comments in js and ts files
  • Enable spellcheck for markdown files with exclusion of code blocks
  • Fix spell errors in comments
  • Add note to CONTRIBUTING.md about spellchecking plugin for vscode
  • Add streetsidesoftware.code-spell-checker as recommended vscode plugin
  • There is no interactive mode

note:

I fixed issues in block code of markdown files before disabling checking for it: numeber -> number

markdown-spellcheck has been introduced in #1324

- Replace outdated package markdown-spellcheck with cspell
- Enable spellcheck for comments in js and ts files
- Enable spellcheck for markdown files with exclusion of code blocks
- Fix spell errors in comments
- Add note to CONTRIBUTING.md about spellchecking plugin for vscode
- Add `streetsidesoftware.code-spell-checker` as recommended vscode plugin
@typescript-eslint

This comment was marked as resolved.

Copy link

typescript-eslint bot commented Dec 28, 2019

Thanks for the PR, @armano2!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@armano2 armano2 changed the title chore: migrate spellcheck to cspell chore: migrate markdown-spellcheck to cspell Dec 28, 2019
@@ -52,6 +52,7 @@ We have a sophisticated CI process setup which gets run on every PR. You must pa
- You can run `yarn lint` in any package or in the root.
- If you have made changes to any markdown documentation, ensure there are no spelling errors
- You can run `yarn check:spelling` in the root.
- Or if you are using vscode, you can use [`Code Spell Checker`](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) plugin.

This comment has been minimized.

Copy link
@armano2

armano2 Dec 28, 2019

Author Member

i'm unsure if this is correct place to add note about this.

Copy link
Contributor

platinumazure left a comment

Just leaving a couple of comments, but nothing I would feel strongly about. (And I'm not a maintainer)

.cspell.json Show resolved Hide resolved
armano2 added 4 commits Dec 28, 2019
@armano2 armano2 requested a review from bradzacher Dec 29, 2019
Copy link
Member

bradzacher left a comment

so many spelling errors.. haha

Thanks for this! LGTM.
Thanks for looking for a maintained alternative. I was thinking at the time that it'd be great to check comments, so this is a great enhancement.

@bradzacher bradzacher merged commit b1c8c0a into typescript-eslint:master Dec 29, 2019
7 checks passed
7 checks passed
Semantic Pull Request ready to be squashed
Details
codecov/patch Coverage not affected when comparing 8bf6879...1fcdf32
Details
codecov/project 94.07% remains the same compared to 8bf6879
Details
typescript-eslint.typescript-eslint Build #20191228.5 succeeded
Details
typescript-eslint.typescript-eslint (Primary code validation and tests) Primary code validation and tests succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_10_x) Run unit tests on other Node.js versions node_10_x succeeded
Details
typescript-eslint.typescript-eslint (Run unit tests on other Node.js versions node_8_x) Run unit tests on other Node.js versions node_8_x succeeded
Details
@armano2 armano2 deleted the armano2:spellcheck branch Dec 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.