Skip to content

TSDoc and TypeDoc link incompatibility when referencing exported members in a separate file that aren't imported #500

Open

Description

@CarterRoll

When using TypeDoc to generate files, you can link to a file in two main ways.

You can use an imported module and link to it directly:

import Component from "@/some/other/Component"
/** {@link Component} */

Or, if it is not imported, you can link to it directly:

/** {@link some/other/Component.default | Component} */

This is an incompatibility with TSDoc's formatting, and will throw a tsdoc-reference-missing-hash error. Unless there is a way to disable this specific error, then TSDoc is unusable with TypeDoc if you want to link to a file that is not imported. I could find no workaround to resolve this incompatibility. The closest you can do is omit the ".default" from the link, but that is not a good solution, and wouldn't even work if that file exported another member.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions