search

streetsidesoftware / cspell

A Spell Checker for Code!
https://cspell.org
MIT License
1.17k stars 84 forks source link

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

Open Jason3S opened 6 days ago

Jason3S commented 6 days ago

Discussed in https://github.com/streetsidesoftware/cspell/discussions/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 - [X] I agree to follow this project's Code of Conduct