EWSoftware / VSSpellChecker

A Visual Studio spell checker editor extension that checks the spelling of comments, strings, and plain text as you type. Supports configuration and various languages.
Other
377 stars 65 forks source link

[Feature Request] Add an option to ignore strings in comments that are declared in code. #233

Closed Robert-Tortorelli closed 3 years ago

Robert-Tortorelli commented 3 years ago

[Feature Request] Add an option to ignore strings in comments that are declared in code.

For example, VSSpellChecker treats 'Vn' as a spelling error in the following comment. 'Vn' is a declared variable, and it would be helpful if all declared variables were ignored in comments. // Vn is computed at run time to be the number of vertices comprising the object. int Vn = 0;

Thank you, Robert

EWSoftware commented 3 years ago

Sorry, but that's not an option given the way it's implemented. That would require parsing the actual code based on the language syntax which isn't possible in the editor extension. It would also be impossible in the solution/project spell checker as it has no way to parse all the various language syntaxes. It may be possible as part of a the planned code analyzer since that is integrated with the language parsing capabilities.

Robert-Tortorelli commented 3 years ago

Thank you Eric. I thought this might be difficult, and I appreciate your reply.

Regards, Robert

On Tue, Jul 27, 2021 at 12:26 PM Eric Woodruff @.***> wrote:

Sorry, but that's not an option given the way it's implemented. That would require parsing the actual code based on the language syntax which isn't possible in the editor extension. It would also be impossible in the solution/project spell checker as it has no way to parse all the various language syntaxes. It may be possible as part of a the planned code analyzer since that is integrated with the language parsing capabilities.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/EWSoftware/VSSpellChecker/issues/233#issuecomment-887655419, or unsubscribe https://github.com/notifications/unsubscribe-auth/APVTA2XOFEKWT7P6FRDWAUDTZ3M4JANCNFSM5AQDNKFA .

Robert-Tortorelli commented 3 years ago

Eric, As an alternative to my impracticable feature request (#233 https://github.com/EWSoftware/VSSpellChecker/issues/233), how about adding a setting that lets the user specify an escape character that tells your extension to ignore the next word in the comment. For example, consider: ignorechar = ' If ignorechar was the new setting, then this would tell your extension to not spell check any word preceded by a single quote. Then a C++ comment such as the following would not result in any reported spelling error: // 'Vn' is computed at run time to be the number of vertices comprising the object. The second single quote that follows Vn is cosmetic and optional, as it is followed by a space character which terminates a word.

If this isn't the proper way to continue this discussion, and if it looks like this email is discarded by GitHub, I'll open a new feature request instead.

Regards, Robert

On Mon, Aug 2, 2021 at 9:48 PM Robert Tortorelli < @.***> wrote:

Thank you Eric. I thought this might be difficult, and I appreciate your reply.

Regards, Robert

On Tue, Jul 27, 2021 at 12:26 PM Eric Woodruff @.***> wrote:

Sorry, but that's not an option given the way it's implemented. That would require parsing the actual code based on the language syntax which isn't possible in the editor extension. It would also be impossible in the solution/project spell checker as it has no way to parse all the various language syntaxes. It may be possible as part of a the planned code analyzer since that is integrated with the language parsing capabilities.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/EWSoftware/VSSpellChecker/issues/233#issuecomment-887655419, or unsubscribe https://github.com/notifications/unsubscribe-auth/APVTA2XOFEKWT7P6FRDWAUDTZ3M4JANCNFSM5AQDNKFA .

Robert-Tortorelli commented 3 years ago

Nevermind... I realize setting the following Exclusion Expression accomplishes essentially the same thing:

Regular Expression: '[^']*' Comment: Match single quote, then everything that's not a single quote, then a single quote, e.g., // 'splled wrng'

On Sun, Aug 22, 2021 at 3:17 PM Robert Tortorelli < @.***> wrote:

Eric, As an alternative to my impracticable feature request (#233 https://github.com/EWSoftware/VSSpellChecker/issues/233), how about adding a setting that lets the user specify an escape character that tells your extension to ignore the next word in the comment. For example, consider: ignorechar = ' If ignorechar was the new setting, then this would tell your extension to not spell check any word preceded by a single quote. Then a C++ comment such as the following would not result in any reported spelling error: // 'Vn' is computed at run time to be the number of vertices comprising the object. The second single quote that follows Vn is cosmetic and optional, as it is followed by a space character which terminates a word.

If this isn't the proper way to continue this discussion, and if it looks like this email is discarded by GitHub, I'll open a new feature request instead.

Regards, Robert

On Mon, Aug 2, 2021 at 9:48 PM Robert Tortorelli < @.***> wrote:

Thank you Eric. I thought this might be difficult, and I appreciate your reply.

Regards, Robert

On Tue, Jul 27, 2021 at 12:26 PM Eric Woodruff @.***> wrote:

Sorry, but that's not an option given the way it's implemented. That would require parsing the actual code based on the language syntax which isn't possible in the editor extension. It would also be impossible in the solution/project spell checker as it has no way to parse all the various language syntaxes. It may be possible as part of a the planned code analyzer since that is integrated with the language parsing capabilities.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/EWSoftware/VSSpellChecker/issues/233#issuecomment-887655419, or unsubscribe https://github.com/notifications/unsubscribe-auth/APVTA2XOFEKWT7P6FRDWAUDTZ3M4JANCNFSM5AQDNKFA .