`getTextOfJSDocComment` introduces a space in JSDoc comments · Microsoft/TypeScript#59679

Repository metrics

Stars: (48,455 stars)
PR merge metrics: (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

🔎 Search Terms

getJSDocTags getTextOfJSDocComment

🕗 Version & Regression Information

Tested on 5.5.4, also existed on previous versions.

⏯ Playground Link

https://stackblitz.com/edit/gettextofjsdoccomment-dbm6rj?file=main.ts,package-lock.json

💻 Code

import ts from 'typescript';

const filename = 'example.ts';
const code = `
/** 
 * 
 * @see {@link entry()}
 */
class Foo  {};
`;

const sourceFile = ts.createSourceFile(
  filename,
  code,
  ts.ScriptTarget.ESNext,
  true
);

const visitNode = (node: ts.Node) => {
  ts.forEachChild(node, visitNode);
  const tags = ts.getJSDocTags(node);
  if (tags.length) {
    tags.forEach((tag) => {
      const comment = tag.comment!.slice(1) as any;

      console.log(
        tag.tagName.getText(),
        '> ',
        ts.getTextOfJSDocComment(comment)
      );

      //console.log(comment);
    });
  }
};

ts.forEachChild(sourceFile, visitNode);

🙁 Actual behavior

getTextOfJSDocComment returns {@link entry ()}. Notice the space inbetween.

🙂 Expected behavior

getTextOfJSDocComment returns {@link entry()}. Notice the space inbetween.

Additional information about the issue

This is a variation of #58584.

Also noticed it happened with {@link core/inject} becoming {@link core /inject}

Contributor guide

Research direction: Inspect the `getTextOfJSDocComment` function in the TypeScript compiler source, and understand how it processes JSDoc comment text. Look for how it handles whitespace around inline tags like `{@link ...}`. This is similar to issue #58584, so examining the fix for that issue may provide guidance.
Tech stack: typescript
Domain: api
Issue type: Bug
Difficulty: 2
Estimated time: 1-3 hours
Activity status: Active
Clarity: Clear
Prerequisites: TypeScript
Newbie friendliness: 75