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

💡: Typos only or non-strict mode to only flag common issues or forbidden words #5820

Open
1 task done
Jason3S opened this issue Jun 26, 2024 Discussed in #5751 · 0 comments
Open
1 task done

Comments

@Jason3S
Copy link
Collaborator

Jason3S commented Jun 26, 2024

Discussed in #5751

Originally posted by Jason3S May 29, 2024

Problem

One common frustration of CSpell users is that it flags variable names and imported libraries, when they are just wanting the spell checker to look for common spelling mistakes. A "Typos" mode would tell the spell checker to be less strict. To only mark issues that are clear mistakes or are in the list of words to be flagged.

Solution

  • add a new boolean configuration option strict, which is true by default.
    • true - the current behavior - all unknown words are marked as errors.
    • false - only common spelling issues and flagged words will be marked as errors.
  • add document directives to enable/disable strict mode within a document.

Alternatives

The other alternative is to provide more control over the parts of a document that is checked by parsing the document and tagging sections (i.e. string, variable, comment) and allowing the user to enable checking.

Note: this proposal can be used in conjunction with parsing.

Additional Context

image

Code of Conduct

  • I agree to follow this project's Code of Conduct
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