Some cross-repository links not resolving
Search terms
multiple repository link
Expected Behavior
TypeDoc links to objects in dependency repository.
Actual Behavior
Showing error messages with failed resolution.
Steps to reproduce the bug
I have a TypeDoc project spread across multiple repositories. To replicate the messages I'm seeing, create an empty directory and run the following:
git clone --depth 1 --branch v1.0.26-beta https://github.com/aidc-toolkit/core.git
cd core
npm clean-install
npm run build:dev
cd ..
git clone --depth 1 --branch v1.0.26-beta https://github.com/aidc-toolkit/utility.git
cd utility
npm clean-install
npm run build:dev
cd ..
git clone --depth 1 --branch v1.0.26-beta https://github.com/aidc-toolkit/gs1.git
cd gs1
npm clean-install
npm run build:dev
cd ..
git clone --depth 1 --branch v1.0.26-beta https://github.com/aidc-toolkit/aidc-toolkit.github.io.git
cd aidc-toolkit.github.io
npm clean-install
npm run typedoc -- --logLevel Verbose
I'm getting these messages:
[warning] The comment for GS1.AI82_CREATOR links to "Exclusions.AllNumeric" which was resolved but is not included in the documentation. To fix this warning export it or add { "@aidc-toolkit/utility": { "__type.AllNumeric": "#" }} to the externalSymbolLinkMappings option
[warning] The comment for GS1.AI82_VALIDATOR links to "Exclusions.AllNumeric" which was resolved but is not included in the documentation. To fix this warning export it or add { "@aidc-toolkit/utility": { "__type.AllNumeric": "#" }} to the externalSymbolLinkMappings option
[warning] The comment for GS1.AI39_CREATOR links to "Exclusions.AllNumeric" which was resolved but is not included in the documentation. To fix this warning export it or add { "@aidc-toolkit/utility": { "__type.AllNumeric": "#" }} to the externalSymbolLinkMappings option
[warning] The comment for GS1.AI39_VALIDATOR links to "Exclusions.AllNumeric" which was resolved but is not included in the documentation. To fix this warning export it or add { "@aidc-toolkit/utility": { "__type.AllNumeric": "#" }} to the externalSymbolLinkMappings option
Other artefacts in the GS1 project that link to Utility work fine, e.g., the documentation for IdentifierValidator links to StringValidator without any problem.
Environment
- TypeDoc version: 0.28.15
- TypeScript version: 5.9.3
- Node.js version: 24.11.0
- OS: macOS 26.1
That's... far from minimal. I don't have time this weekend to burn trying to figure out what in there is actually important to reproduce the issue.
The gs1 project depends on the utility project. In the gs1 project is this file:
https://github.com/aidc-toolkit/gs1/blob/v1.0.26-beta/src/character-set.ts
There are multiple links like this:
{@linkcode Exclusions.AllNumeric}
That references this file in the utility project:
https://github.com/aidc-toolkit/utility/blob/v1.0.26-beta/src/exclusion.ts
Everything else is resolving across projects (source maps are being generated etc.); it's just that particular edge case that's having trouble.
Yes, but to actually figure things out I have to sift through an extra thousand symbols to get just the symbols which are important. Minimal repros are great partially because it's reasonable to actually step through the entire conversion process, whereas in a project like this conditional breakpoints or some other type of filtering are essential to getting just what I guess is important.
And I have the opposite problem, finding the time to trim it down to something that shows the same error while still compiling. I'll do what I can when I can, but at a glance I can say that removing everything from gs1/src except character-set.ts, and editing index.ts accordingly, will get the gs1 project down to a single source file where the problem is triggered.
The referenced project, utility, can't be trimmed much because its own src/character-set.ts file depends on almost all of the other files, including exclusion.ts, which is where the referenced object is defined.