Typedoc not honoring compilerOptions: paths?

[michaeltford]

I have a mono repo with a tsconfig.json that contains paths

 "paths": {
      "@sheetxl/common/*": ["packages/common/src/*"],
      "@sheetxl/models/*": ["packages/models/src/*"],
}

With the follow typedocs.json

{
  "entryPoints": ["packages/*/src/index.ts"],
  "name": "SheetXL"
}

The docs are almost working but I would expect it to generate links that
follow @sheetxl/common (or even just common) instead of common_src.

see
https://api.sheetxl.com/modules/common_src.html

Is there a workaround where I can redefine or alias these within typedocs?

[Gerrit0]

You're probably after the @module tag, which can be used to rename an entry point - https://typedoc.org/tags/module/

This is working as designed:

1. The file path is always a valid method of referring to the file.
2. Multiple paths entries may map to the same file, so typedoc would have to arbitrarily choose one in those cases.
3. Paths are terrible hacky things that don't represent how things work in any (non-bundled) runtime and should be avoided in favor of referencing projects as dependencies. Even npm today will symlink projects within node_modules if set up as a monorepo

[michaeltford]

Thanks @Gerrit0 for the quick response.

#3. I agree paths do seem very hacky but I wasn't able to get visual studio code to work without them. I will review trying to get rid of the path attribute again.

#2. I am not sure this is correct. typescript will also fail if there is more than one alias to the same path or it too would have to arbitrarily pick. (I think).

#1. Because of #3 the paths are only valid before bundle but not actually valid after bundle because typescript alters based on the paths attribute. (the /src path partial is removed.).

[Gerrit0]

The case I'm describing is this:

 "paths": {
      "@sheetxl/common/*": ["packages/common/src/*"],
      "@sheetxl/also-common/*": ["packages/common/src/*"],
}

This is completely fine for paths, but means that a path within there could be "mapped" back to multiple path aliases.