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 the scanned unknown word to ignored word list in the config file #4725

Open
xnivaxhzne opened this issue Aug 17, 2023 · 2 comments
Open

Comments

@xnivaxhzne
Copy link

Is your feature request related to a problem? Please describe.
Let's assume you are planning to setup the spell checker first time for a project. Most of the time, your project would contain lot of unknown words(not found in dictionary), but are project specific. When you scan, you will get lot of errors with those unknown words. But you don't want them to be renamed as they are project specific. So, you manually add them to cspell.json file to be ignored. This I feel a very tedious process. It happened to me today.

Describe the solution you'd like
For the very first scan, we can add the list of unknown words to the config file automatically and let the user to make decision about it. Since 90% of them needs to be ignored and only 10% is to be corrected for spelling.

Additional context
I am not sure any other solution exists already, but I think it would be a cooler one if have it.

@Jason3S
Copy link
Collaborator

Jason3S commented Aug 18, 2023

You make an excellent suggestion. On boarding a new project is currently more painful than it needs to be.

Related to #3, #2301

See also: Getting Started with CSpell | CSpell

@xnivaxhzne
Copy link
Author

@Jason3S This instruction is what I wanted. Will use it.

Here is my feedback seen from a beginner eye. We can include the above instruction explicitly in the npm page(https://www.npmjs.com/package/cspell) or atleast a link to it. Helpful for onboarding.

Or as suggested in #3, we can have some init command to automate this process.

Thanks.

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

2 participants