chore: introduce eslint-plugin-spellcheck#2603
chore: introduce eslint-plugin-spellcheck#2603Shinigami92 wants to merge 2 commits intovitejs:mainfrom Shinigami92:introduce-spellcheck
Conversation
antfu
left a comment
There was a problem hiding this comment.
I am not sure if introducing an eslint-plugin could be a bit overkill. But in general, I think this is a good PR as it will reduce the future typo-fix commits noises a lot.
|
My first reaction was to reject it because of renames like I also think that this would be positive. Is there something similar for markdown files so the docs are checked? |
I'm not directly sure. Currently it may be possible to configure eslint to not only check js,ts etc. |
|
For the plugin, I'd actually prefer one-time CLI tools or IDE extensions as I don't think spell check is something that important to persistent live in the CI process. We can run spell check once a while and fix them in a single commit so we don't need to sacrifice anything while keeping the commit history cleaner. |
|
A nice thing using the lint step could be to show it directly in the review There is a VSCode Plugin: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker We could extract an additional lint script that specifically lint the project for spell-check. But in the end it is kinda the same as just running it in the normal lint step and otherwise folks would just forget to run it / the forget it. |
^ I agree with this - we could just run a typecheck tool once in a while. I don't really want spellcheckers to lint/affect source code variable names. |
|
@Shinigami92 Maybe let's close this for now? |
I added
eslint-plugin-spellcheckand configured it (a bit)Then I fixed some typos f7d69f4
Also I renamed some wordings 1675b3c
If preferred I can revert the renames
It's also arguable if you want
eslint-plugin-spellcheckin the project and have such a "huge" config of wordsI may contact @aotaduy so they can adept some common words. That could also help other projects out there 🙂