Typedoc: Schema for typedoc.json

[bencooper222]

• [X ] I have checked issues with enhancement label and found no duplicates

Problem

VSCode doesn't build in Typedoc support the way it does for prettier and such. A simple $schema (https://json-schema.org/) for the the options would be awesome.

Suggested Solution

Just a link to the schema on the website. I'd be willing to write up the schema if I get an indication that the PR would be merged in upon completion.

[Gerrit0]

:+1: this would be a great addition, and should resolve #962. I'm not very familiar with the json-schema project. Should the schema be included on the TypeDoc website, or is there a standard site where it should be hosted?

[bencooper222]

I know that VSCode at least pulls from here: http://schemastore.org/json/.

Source

[Gerrit0]

That seems like an ideal solution for the most exposure. If I understood that page correctly, the submission should be to that repo, though it looks like it might be possible to generate the schema from the option declarations in the current source, which should probably live in this repo.

[bencooper222]

I'm trying to write the schema right now and I have 100% coverage of the itemized options from "out" onwards. I'm having two issues right now:

• [ ] Can everything listed under typedoc --help (even if it doesn't have a section header) be part of the options file?
• [x] This isn't really an issue that's blocking me but "externalPattern" has two duplicate headers with "excludeExternals" separating them on this page.

[Gerrit0]

The code to load from an option file is here, it looks like yes, all options can be loaded.

There's also apparently the additional property src which may be either a string, or a string array, and is used to specify the inputFiles. This corresponds to passing a path on the command line without an attached argument. This isn't documented anywhere currently to the best of my knowledge, I just learned about it now.

[bencooper222]

Please take a look at my PR in the schemastore repo (directly above)! I believe I accurately reflected the available options but would greatly appear checking of work. Options appear in the same (i.e. alphabetical) order that they appear on the site.

[bencooper222]

Looking at the catalog of schemas, some projects maintain the schema in their repo while others maintain it in the schemastore project's repository. I'm pretty impartial as to which happens as I think it's a decision for people who are more actively involved than I am. That said, there do seem to be tools to convert TS interfaces to JSON schemas: https://github.com/YousefED/typescript-json-schema

[Gerrit0]

That's good to know. It would be great to automatically generate the schema from the options declarations. I think there's almost enough information already included in the source, and adding the rest shouldn't be too difficult. I think that should be tracked in a different issue though, for now going with your PR is probably best, though I'd like to hear what @aciccarello thinks.

[aciccarello]

Yeah, I like the I idea of automatically generating the schema however that'd be a pretty low priority issue. 👍

[bencooper222]

I'll give it a shot

[bencooper222]

Can someone point me to the interface that defines the options for typedoc.json?

[Gerrit0]

There isn't one. Each option is declared by itself with the @Option decorator.

[Gerrit0]

Closing as the PR over at schemastore has been merged. Thanks again :)