search

bartosz-antosik / vscode-spellright

Multilingual, Offline and Lightweight Spellchecker for Visual Studio Code
Other
364 stars 37 forks source link

Errors flagged in correctly spelled JSDoc statements #288

Open odonyde opened 5 years ago

odonyde commented 5 years ago

Spell Right erroneously reports errors in correctly spelled JSDoc statements:

  1. JSDoc tag @param is falsely marked as erroneous
  2. Function parameter calcPrecoPrazoMethod is marked as erroneous even though spellright.useDocumentSymbolsInCode is set to true

SpellRight - JSDoc errors

Spell Right: 3.0.38
Visual Studio Code: 1.35.0 (Stable)
OS: Windows 10 Pro x64 1809 17763.529

Extension User Settings:
  "spellright.documentTypes": ["plaintext", "markdown", "typescript"],
  "spellright.language": ["en"],
  "spellright.useDocumentSymbolsInCode": true

Extension Workspace Settings:
  "spellright.documentTypes": ["plaintext", "markdown", "typescript"],
  "spellright.language": ["de", "en", "pt"]
bartosz-antosik commented 5 years ago

Hi! Thanks for noticing. Could you please drop me the example in copy-pasteable form? Would be much easier to see the problem.

odonyde commented 5 years ago

Sure! Spell Right flags the mentioned errors if I create a TypeScript file example.ts with the following content:

/**
 * Example function to demonstrate issue with spell checking of JSDoc statements
 *
 * @param calc Example parameter name which should not be marked as erroneous
 */
function ExampleFunction(calc: any) {
    return calc;
}

As I have set spellright.useDocumentSymbolsInCode to true, I would expect that Spell Right does not report any spelling mistake for this TypeScript file. But in the comment section both the JSDoc tag @param and the function parameter name calc are marked as erroneous:

image