Cross-package references in monorepository not working

Search terms

monorepository entrypointStrategy packages reference

Expected Behavior

Cross-package references should “work” when generating documentation for several packages in a monorepository (using yarn workspaces), with an entrypointStrategy set to packages.

Actual Behavior

Cross-package references yield a warning:

A, defined at packages/a/lib/index.d.ts:3, is referenced by @typedoc-packages-missing-export/b.B.__type.a but not included in the documentation.

And the resulting documentation does not have hyperlinks for such references.

Steps to reproduce the bug

Here is an example repository to reproduce the bug: https://github.com/nlepage/typedoc-packages-missing-export

Environment

• Typedoc version: 0.22.10
• TypeScript version: 4.5.4
• Node.js version: 14.17.0
• OS: Linux

[nlepage]

Hey @Gerrit0

I made a plugin to solve the problem: nlepage/typedoc-plugin-resolve-crossmodule-references. Not sure about all of it, but it works fine for the basic cases. Here is an example of generated documentation where types from a module a reference a type B from a module b. It is published on npm.

I’m not sure if it can help with project references as I’m not familiar with these.

Let me know if it is something you would like to integrate in TypeDoc itself. It needs only one new dependency (plus a transitive one): convert-source-map.

[nlepage]

@nlepage Are there any prerequisite I need to know or settings made to get your plugin working? I just installed and tried but unfortunately it did not work for me 😦

@phihochzwei I published a new release of the plugin, let me know if it works for you.