Support tsconfig.json

[bryanforbes]

Since projects can specify their compiler options and included files via tsconfig.json, it would be great if typedoc would support specifying generating documentation by passing it a tsconfig.json. I could see the following as the command-line invocation:

$ typedoc --mode modules --exclude **/tests/** --excludeNotExported --out docs tsconfig.json

In my mind, this would get the list of project files from tsconfig.json's files property, apply the exclude pattern to those files, get the compiler options from the compilerOptions property, and then generate the docs.

[sebastian-lenz]

Hi Bryan, thank you for sharing this. I think this is a good idea, maybe we could even append the documentation parameters to tsconfig.json so they can be easily shared with others.

[ghost]

+1

[hourliert]

👍

[stepancar]

+1

[dabbank]

+1

[eggers]

👍

[joemcelroy]

👍

[listepo]

+1

[xstof]

+1

[meriturva]

+1

[dsebastien]

+1

[josh-fisher]

+1

[readme42]

+1

[tforgione]

+1

Any news on this ?

[DanielJoyce]

Yeah, typedoc is pretty much worthless for me without this. Also ships with moldy old typescript version ( 1.6 ) and can't find how to get it to use different version.

[cfischer]

+1

[lholznagel]

Guys, please!
When you are intressted in this topic, please click on Subscribe.
If you want to to say that this is a nice feature just click on the smiley and press your reaction. Github added that for a reason. One of the reason is that the +1 is annoying for all that subscribed or watch a issue/repo.

Thanks!

[DaSchTour]

But reactions don't make me a participant and when watching a repo I want to me notified in a different way for certain topics.

[tht13]

Then click the subscribe button in the column on the right

[DaSchTour]

There is only an Unsubscribe Button.

[tforgione]

It's an unsubscribe button only because you're already subscribed...

[DaSchTour]

Yes and it was already an Unsubscribe when I entered this topic. But now I see it in my Participating block in my Notifications.

[TobiaszCudnik]

Seems like its supported now. With typedoc --help you get

--tsconfig Specify a js option file that should be loaded. If not specified TypeDoc will look for 'typedoc.js' in the current directory.

[blakeembrey]

Thanks @TobiaszCudnik

Feel free to open a new issue if there's any problems that come up 😄