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

Add cspell checking #11954

Open
jjspace opened this issue Apr 23, 2024 · 0 comments
Open

Add cspell checking #11954

jjspace opened this issue Apr 23, 2024 · 0 comments

Comments

@jjspace
Copy link
Contributor

jjspace commented Apr 23, 2024

CSpell is a really nice library/collection of tools to add spell checking to code. It's mostly used through the VSCode extension. However it does have a CLI and library version that can be used in things like git pre-commit checks or CI. Longer term this might be helpful to maintain good spelling. Definitely not a top priority but could be nice to add.

Custom dictionary

The key part that's needed to start using the CLI is having a custom dictionary of words that are valid in the project but not in existing dictionaries. #11953 was added to start building that.

When a word is flagged you just have to put the cursor on it and trigger the VSCode suggestion window Ctrl+. for me. Then just make sure you select the cspell.json file to make sure it's added to the repo's dictionary instead of your user or workspace settings.

2024-04-23_11-54
2024-04-23_11-54_1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant