Global input options not taken into account in a monorepo

[jjanvier]

Search terms

Input, Options, Packages, Monorepro

Expected Behavior

I have a monorepo like this.

typedoc.json
libs/
  |-- foo/
        |-- src/
  |-- bar/
        |-- src/

With this configuration, I expect the Caching category to not appear in the documentation.

{
  "entryPointStrategy": "packages",
  "entryPoints": [
    "libs/foo",
    "libs/bar",
  ],
  "cleanOutputDir": true,
  "packageOptions": {
    "entryPoints": ["src/index.ts"]
  },
  "excludeCategories": ["Caching"], // not working
  "excludeNotDocumented": true, // not working
  "outputs": [
    {
      "name": "html",
      "path": "docs/tsdoc",
      "options": {
        "navigation": {
          "includeCategories": true,
          "includeGroups": true,
          "excludeReferences": false,
          "includeFolders": false
        }
      }
    }
  ]
}

Actual Behavior

The problem is that the Caching category appears in the documentation. As well as undocumented stuff.

To make them disappear, I must add a libs/foo/typedoc.json file with the following configuration.

{
  "excludeCategories": ["Caching"], 
  "excludeNotDocumented": true
}

But that's not what I want, as all root configurations would use this file. (I have several root configuration, to build different documentations)

Environment

• Typedoc version: 0.27.6
• TypeScript version: 5.7.3
• Node.js version: v18.20.5
• OS: MacOs

Is there something I'm doing wrong? Or is it a bug?

[Gerrit0]

See https://typedoc.org/documents/Options.Package_Options.html

Packages mode is special, options must be set where they are used.

[jjanvier]

Hello @Gerrit0 :) Thanks for you answer. What does it mean? That what I want to achieve is impossible?

[Gerrit0]

You can use the packageOptions option to set the option in the root configuration and tell TypeDoc to copy it to each package, but that option takes effect during conversion, not during rendering, so it needs to be set in the package project's configuration.