How to resolve links without writing full path

[SummerPluviophile]

Hi!
In my project to resolve links I have to write a full path like {@link src/../../get-resources.getResources getResources} but i want to be able to just write name of the function to resolve it. I tried to manually find these paths and insert them into links using custom-typedoc-theme. And I can insert a file path using app.converter.on("resolveBegin"), but I need the path to the reflection, which generates later, not a path to the original file. If I've read correctly, typedoc generates a path if I return a Reflection, but it does not work.
Is this not the correct way to get a path to generated reflection? Is there some way to resolve links without writing the whole path each time?

Here's code of the functions in custom-typedoc-theme:

export function load(app) {
    app.converter.on("resolveBegin", (context) => {
        const nameMap = buildExportMap(context.project);

        app.converter.addUnknownSymbolResolver((ref) => {
            const name = ref.symbolReference?.path?.[0]?.path || ref.toString();
            const reflection = nameMap[name];
            if (reflection) {
                return reflection;
            }

            return undefined;
        });
    });

    app.renderer.defineTheme("custom-markdown-theme", MyMarkdownTheme);
}

function buildExportMap(project) {
    const map = {};

    for (const refl of Object.values(project.reflections)) {
        if (
            refl.isDeclaration &&
            refl.sources?.[0] &&
            !refl.sources[0].fullFileName.includes("node_modules")
        ) {
            map[refl.name] = refl;
        }
    }
    return map;
}

typedoc.json:

{
    "entryPoints": ["./src", "./packages/server"],
    "out": "packages/docs/content",
    "plugin": ["typedoc-plugin-markdown", "./tools/custom-typedoc-theme/custom-typedoc-theme.mjs"],
    "theme": "custom-markdown-theme",
    "excludePrivate": true,
    "excludeProtected": true,
    "suppressCommentWarningsInDeclarationFiles": true,
    "projectDocuments": ["./docs/**/*.md", "./README.md"],
    "hideBreadcrumbs": true,
    "entryPointStrategy": "expand",
    "excludeNotDocumented": true,
    "readme": "none",
    "useTsLinkResolution": false
}

Versions:

  "typedoc": "^0.28.7",
  "typedoc-plugin-markdown": "^4.7.1",
  "typescript": "^5.8.3"

[kooroshkz]

Heyy
You’re on the right track! You can resolve links by name without full paths using addUnknownSymbolResolver, but the key is to wait until reflections are fully available. Try moving your addUnknownSymbolResolver call outside of resolveBegin — right after buildExportMap, since reflections should already be ready at that point.

Also, make sure nameMap handles duplicates properly (e.g. functions with same name in different files). You might need to add some logic to disambiguate.

Feel free to mark this as the answer if it helps!

[SummerPluviophile]

Hi again! I moved addUnknownSymbolResolver outside of resolveBegin:

export function load(app) {
    let nameMap = {};

    app.converter.on("resolveBegin", (context) => {
        nameMap = buildExportMap(context.project);
    });

    app.converter.addUnknownSymbolResolver((ref) => {
        const name = ref.symbolReference?.path?.[0]?.path || ref.toString();
        const reflection = nameMap[name];
        if (reflection) {
            return reflection;
        }

        return undefined;
    });

    app.renderer.defineTheme("custom-markdown-theme", MyMarkdownTheme);
}

Also I added logic for duplicates in nameMap. But it didn't do anything, did I understand you correctly?

[Gerrit0]

"useTsLinkResolution": false

If possible, I highly recommend turning this option back on. When you turn it off, TypeDoc no longer uses TypeScript to attempt to resolve links, which is what's causing this problem in the first place.

addUnknownSymbolResolver cannot return a reflection. I'm guessing some AI tool lied to you about that as I don't see anything in TypeDoc's docs which would imply that.

If you want to leave useTsLinkResolution off and use your custom export map to resolve links, you'll have to override Converter.prototype.resolveLinks and re-implement this part of the link resolver