typedoc: typedoc.js Stops Working after Writing Configuration in tsconfig.js is Supported.

@Laroosta I didn’t read @ZheyangSong issue in the detail but you can add your json in a typedocOptions key of your tsconfig.json

In my case

{
  "compilerOptions": {
     //...
  },
  "typedocOptions": {
    "mode": "modules",
    "out": "docs",
    "exclude": "test",
    "theme": "default",
    "ignoreCompilerErrors": true,
    "excludePrivate": true,
    "excludeNotExported": true,
    "target": "ES5",
    "moduleResolution": "node",
    "preserveConstEnums": true,
    "stripInternal": true,
    "suppressExcessPropertyErrors": true,
    "suppressImplicitAnyIndexErrors": true,
    "module": "commonjs"
  }
}

Your command become

typedoc index.ts

I’m not a big fan of it as tsconfig is used by a lot of third party libraries for their config and often not very well documented… But it works for me.

I’m in favor of fixing typedoc.json support and dropping typedoc.js support. If people need dynamic control of typedoc, they can require the application directly.

@cancerberoSgx I can imagine having a .js config file being helpful but my main hesitation is that it seems to make more sense to require typedoc as a node module in that case. It is extra API surface area that only adds a minor improvement.

For the time being, supporting typedoc.js isn’t too difficult so I don’t think it’ll be removed anytime soon.

@paulsouche Thanks for the reply.

If I roll back to v0.8.0, it works using the json file. I’ll update to v0.9.0 and try your suggestion!

@aciccarello Unfortunely I am using typedoc in a mono repo and need to resolve each packages config file.

When I run the cmd suggested I get:

typedoc --options=/home/brian/Documents/Development/pixeloven/packages/pixeloven-core/typedoc.json
Error: Unknown option: options=/home/brian/documents/development/pixeloven/packages/pixeloven-core/typedoc.json
error Command failed with exit code 1.

Here is the configuration:

{
    "name": "@pixeloven/core",
    "target": "es5",
    "out": "docs",
    "ignoreCompilerErrors": "false",
    "preserveConstEnums": "true",
    "exclude": "*.test.ts",
    "stripInternal": "false"
}

This works well as a .js file and without the --options=

Hi folks, I didn’t realize that this issue could become somewhat confusing to some followers. The title of this PR was based on my understanding of the code change history up to the moment I opened this issue. There was some commit that removed parsing of js configuration file and added tsconfig.json support. I thus thought the intention was to brace tsconfig.json but still expose a minimal API surface to be used in nodejs modules, thus you can use it to create plugins/loaders. I have no objection to making this tool support multiple configuration formats. Unfortunately, I didn’t quite track this issue after being caught by my job… but I’ll change the title to avoid confusion…

I don’t see the advantage of removing the support of the .js as it is already in code and you can use either of the formats that suits your liking. Just because some prefer plain JSON doesn’t mean everyone does.

For the majority of people the typedoc CLI is enough and it would be kinda tedious to have to create a file and include typedoc as a module just because you want a bit of dynamic in the config.

Supporting both formats is something many major modules have been doing for years (Webpack or Babel just name a few) and I have the impression that people like that freedom of choice.

So overall just make the handling of both files work and continue the support IMHO.

I understand the reasons behind this issue but currently, having configuration in .ts or .js files gives a very useful feature out of the box and pretty easy and straight forward: configuration hierarchy (like tsconfig.json “extends”). I’m not saying not to do it but be conscious that if you also don’t implement something like tsconfig.json’s extends property then users will loose a very very useful feature. Example:

File typedoc-config-base.ts:

module.exports = {
  src: ['./src'],
  mode: 'file',
  includeDeclarations: true,
  tsconfig: 'tsconfig.json',
  excludePrivate: true,
  excludeProtected: true,
  excludeExternals: true,
  readme: 'README.md',
  name: 'my-cool-project',
  ignoreCompilerErrors: true,
  plugin: 'none',
  listInvalidSymbolLinks: true,
};

File typedoc-config-html.ts:

module.exports = {
  ... require('./typedoc-config-base.ts'),
  out: '../docs/html',
}; 

File typedoc-config-md.ts:

module.exports = {
  ... require('./typedoc-config-base.ts'),
  theme: 'markdown',
  plugin: 'typedoc-markdown-plugin',
  out: '../docs/md',
}; 

Wonder If both json and js could be supported ?