Allow to specify a custom tsconfig in packages mode for monorepos

[avchugaev]

Search Terms

Monorepo, tsconfig, custom path

Problem

When operating in monorepo mode (multiple packages), each package may contain several tsconfig files.
For instance, Nx generates 3 tsconfig files per TypeScript project:

• tsconfig.json - base configuration, extends workspace's root tsconfig;
• tsconfig.lib.json - production code configuration, extends package's tsconfig.json;
• tsconfig.spec.json - tests configuration, extends package's tsconfig.json.

When one generates documentation for several packages, TypeDoc uses tsconfig.json instead of desired tsconfig.lib.json without ability to override the file name (or location).

Suggested Solution

Allow to override package's tsconfig file name (location) via package.json settings:

{
  "name": "@org/package-a",
  "typedoc": {
    "entryPoint": "./src/index.ts",
    "readmeFile": "./README.md",
    "tsconfig": "./tsconfig.lib.json"
  }
}

So that TypeDoc will be more monorepo-friendly and multi-config-friendly.

[ed-jinyoung-park]

I have same problem on generating docs with nx projects.
hope this suggestion applies well.

[avchugaev]

@Zinyon Hi! Just curious, do you publish the resulting API reference to GitHub pages?

[ed-jinyoung-park]

@avchugaev Hi!, i'm considering it, but haven't tried yet.
have you tried?

[avchugaev]

@avchugaev Hi!, i'm considering it, but haven't tried yet. have you tried?

Yep, I managed to generate docs for all libraries from Nx workspace and deploy them to GitHub pages.

• Repository
• Deployed documentation

But to achieve this, I had to rename tsconfig* files in every library so that TypeDoc resolved the right tsconfig.json. So it pushed me to override default configs generated and maintained by Nx.

[avchugaev]

@Gerrit0 I'd try to implement it, but I need help understanding the codebase and solution design.

[Gerrit0]

The relevant code starts at https://github.com/TypeStrong/typedoc/blob/master/src/lib/utils/entry-point.ts#L323, seems reasonable to treat this option like the readmeFile is tested today

[avchugaev]

@Gerrit0 thanks for the feature 🤝 Please check the site build - https://github.com/TypeStrong/typedoc-site/actions/runs/3230626041/jobs/5289289873

There's still a previous version of the docs on the website:

[Gerrit0]

Huh, surprised that didn't give me an email about a failing build... thanks!