Symbol#getJsDocTags adds whitespace in URLs

[RomainMuller]

Bug Report

🔎 Search Terms

@see, JsDocTags

🕗 Version & Regression Information

This changed between 3.9 and 4.1.

💻 Code

/** @see http://lmgtfy.com */
export class Foo {}

🙁 Actual behavior

Consider the exported symbol Foo above... When calling getJsDocTags() on that, the result includes:

{ text: 'http ://lmgtfy.com', name: 'see' }
//           ^-- spurious space

🙂 Expected behavior

Expected the @see tag's text to be represented as-is:

{ text: 'http://lmgtfy.com', name: 'see' }

[z0gSh1u]

This specified problem is introduced since #39760. The parser of compiler always tries to parseJSDocNameReference although there might be none. So, for http://lmgtfy.com, it gets stuck at : since it's an UNKNOWN token for current grammar. Then, http becomes a NameReference, while ://lmgtfy.com is comment. However, the whole string is all comment in fact.

TypeScript/src/compiler/parser.ts

Line 7757 in fd6178b

function parseSeeTag(start: number, tagName: Identifier, indent?: number, indentText?: string): JSDocSeeTag {

TypeScript/src/compiler/parser.ts

Line 7226 in fd6178b

export function parseJSDocNameReference(): JSDocNameReference {

Same problem occurs with @implements and maybe more JSDoc annotations for [email protected].

[sandersn]

@z0gSh1u's analysis is correct. The comment-parsing part of jsdoc parsing skips initial whitespace, which isn't correct for jsdoc where whitespace is usually significant. getJsDocTags then separates the name of a tag from the comment with a space. Unfortunately, it's a fairly large change to fix this.

The output of getJsDocTags is now DisplayParts in 4.3, but it still inserts the space.