Skip to content

compiler api: jsdoc parse links in tags #44712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
atanasster opened this issue Jun 23, 2021 · 1 comment
Closed

compiler api: jsdoc parse links in tags #44712

atanasster opened this issue Jun 23, 2021 · 1 comment
Assignees
Labels
Needs Investigation This issue needs a team member to investigate its status.

Comments

@atanasster
Copy link

tags containing : text are split into two tag items
example:

  /**
   * @see https://reactjs.org/docs/context.html#classcontexttype
   */
  export class Component{
    static contextType?: Context<any>;
  }

symbol.getJsDocTags() will return two @see items:

[
  {
    name: "see",
    text: [
      {
        text: "https",
        kind: "text",
      },
      {
        text: "://reactjs.org/docs/context.html#classcontexttype",
        kind: "text",
      },
    ],
  },
]

⭐ Suggestion

If possible keep the link line into a single tag item

A test repo to reproduce the issue: https://github.com/atanasster/ts-issues/blob/master/tests/see-https.test.ts

@atanasster atanasster changed the title api-compiler: jsdoc parse links in tags compiler api: jsdoc parse links in tags Jun 23, 2021
@RyanCavanaugh RyanCavanaugh added the Needs Investigation This issue needs a team member to investigate its status. label Jun 24, 2021
@RyanCavanaugh RyanCavanaugh added this to the TypeScript 4.4.1 (RC) milestone Jun 24, 2021
@atanasster
Copy link
Author

closing, this can be fixed using the jsdoc compiler api: #44930

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Investigation This issue needs a team member to investigate its status.
Projects
None yet
Development

No branches or pull requests

3 participants