chore: migrate markdown-spellcheck to cspell #1386
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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
This comment has been minimized.
This comment has been minimized.
armano2
commented
Dec 28, 2019
packages/typescript-estree/src/create-program/createWatchProgram.ts
Outdated
Show resolved
Hide resolved
bradzacher
approved these changes
Dec 29, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently used
markdown-spellcheckseems to be no longer maintained and uses dictionaries and dependencies that are outdated.I prepared PR to
markdown-spellcheckthat fixes issues, updates dictionaries and dependencies lukeapage/node-markdown-spellcheck#135 but so far there is no response from author/maintainers.Difference between
markdown-spellcheckandcspellmarkdown-spellcheckcan only parse and do spell checking on markdown files.cspellon 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
cspellcomes 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,filetypesterms.Notable changes:
streetsidesoftware.code-spell-checkeras recommended vscode pluginnote:
I fixed issues in block code of markdown files before disabling checking for it:
numeber->numbermarkdown-spellcheckhas been introduced in #1324