Onward links to https://www.npmjs.com/ package resources or similar

[cefn]

Search terms

Sourcelink, npm module,

Question

I imagine there's some strategies available for external packages to have links resolved in some way (e.g. to the npm package URL?). I have a feeling I've missed this config or plugin or I'm thinking about the problem wrongly.

To take an example, we have a module which can consume a LoggerOptions configuration which is provided by the winston library and passed on to that library during initialisation. See https://www.npmjs.com/package/winston

Although the details of the type are suitably hoisted and rendered, the LoggerOptions type ends up with a non-linked source reference below its definition like

Defined in node_modules/.pnpm/[email protected]/node_modules/winston/index.d.ts:84

I can almost certainly configure external to be terser about files in node_modules/.pnpm so it doesn't spit out the whole path maybe.

However, better would be for our use of a type like LoggerOptions to imply some onward journey to standard resources for the winston library.

Is there any scheme available to have types referenced from npm-resolved libraries to have an onward journey to documentation of some kind.

For example in this particular case this would mean there was some link to e.g. https://www.npmjs.com/package/winston maybe? Maybe https://github.com/winstonjs/winston/blob/c69cdb0cec15a138e0b6e374501e027d1c39606c/index.d.ts#L84 would be even better if there's a way to resolve it.

[phoneticallySAARTHaK]

Probably not, according to this #2335 (comment)

You'll have to manually create a link

[Gerrit0]

Either a plugin (more flexibility) or an option can be used to resolve external symbols to a link: https://typedoc.org/documents/Development.Third_Party_Symbols.html