Skip to content
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

externalSymbolLinkMappings does not respect symbol IDs #2725

Closed
Gerrit0 opened this issue Oct 4, 2024 · 1 comment
Closed

externalSymbolLinkMappings does not respect symbol IDs #2725

Gerrit0 opened this issue Oct 4, 2024 · 1 comment
Labels
bug Functionality does not match expectation
Milestone

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 4, 2024

Search terms

externalSymbolLinkMappings to TypeScript resolved link

Expected Behavior

Given the following, TypeDoc should produce a link to example.com, and not produce any warnings.

import * as random from "@pulumi/random";

/**
 * Blah blah {@link random.RandomPassword}.
 */
export function someFunction() {}

Config:

/** @type {Partial<import('typedoc').TypeDocOptions>} */
const config = {
  ...,
  externalSymbolLinkMappings: {
    "@pulumi/random": {
      "*": "https://example.com"
    }
  },
};

export default config;

Actual Behavior

TypeDoc produces a warning:

[warning] Failed to resolve link to "random.RandomPassword" in comment for someFunction

Environment

  • Typedoc version: 0.26.8
  • TypeScript version: any
  • Node.js version: any
  • OS: any

Reported by @stazz in #2700

@Gerrit0 Gerrit0 added the bug Functionality does not match expectation label Oct 4, 2024
@Gerrit0 Gerrit0 added this to the v0.26.9 milestone Oct 4, 2024
@Gerrit0 Gerrit0 closed this as completed in 1cefc01 Oct 4, 2024
@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Oct 4, 2024

I'm going to wait until Sunday to publish 0.26.9 as I just made a release earlier today, just in case more issues crop up.

"typedoc": "github:TypeStrong/typedoc#1cefc011948fa06f798a0763ba5cc9d32f6ac04e"

can be used to install TypeDoc with this patch applied in the meantime

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant