@link tag inside a JSDoc type expression doesn't show parse error in TS

[DanielSWolf]

Bug Report

🔎 Search Terms

tsdoc, @throws, @link, tags

🕗 Version & Regression Information

This changed between versions 4.9.5 and 5.0.4

⏯ Playground Link

Playground link with relevant code

💻 Code

class FooError extends Error {}
class BarError extends Error {}

/**
 * Performs blubber.
 * 
 * @throws {@link FooError} if foo happens.
 * @throws {@link BarError} if bar happens.
 */
function blubber() {}

🙁 Actual behavior

The @link tags after the @throw tags are parsed incorrectly, leading to this garbled tooltip:

🙂 Expected behavior

The @link tags after the @throw tags are resolved correctly.

[fatcerberus]

Ah yes, performing blubber, the one feature every piece of software absolutely needs.

[sandersn]

The syntax for throws is @throws {Type} documentation, so the { starts a parse of a type expression, not a link tag.

All the other tags that are followed by a type have the same (or very similar) bug: @param, @implements, @extends, @this, etc.

In JS files with checkJS turned on, the parse error is shown. This is not true for TS files or plain JS files. At this point, maybe it makes sense to show parse errors from jsdoc, at least, in .ts files.

Unfortunately, that would require parsing jsdoc in .ts files. Which would prevent @jakebailey 's PR to disable jsdoc parsing in .ts files from working.

@DanielRosenwasser @gabritto do you have opinions? (I know we've discussed these issues in the past without reaching any consensus.)

[sandersn]

I put up a PR that skips @link at the start of jsdoc types too, since that would help this particular case, and seems like a reasonable mistake to make.