Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow specifying typedoc options in tsconfig.json #658

Closed
dtgriscom opened this issue Dec 7, 2017 · 1 comment
Closed

Allow specifying typedoc options in tsconfig.json #658

dtgriscom opened this issue Dec 7, 2017 · 1 comment
Labels
help wanted Contributions are especially encouraged

Comments

@dtgriscom
Copy link

When I'm working on a given project with tools, I'd rather not have to specify command line arguments for the tool. It makes my work quicker, as well as making it easier for other developers to do the same work. So, I put as many typedoc configuration items as possible into the tsconfig.json in the project's root directory.

Problem: tsconfig requires that you specify the project to be analyzed on the command line. Yes, it isn't a big deal to type typedoc ., but given that typedoc happily looks for a tsconfig.json in the current directory, it would be great for it to either allow specifying the project in the tsconfig.json file, or just assume that if no directory is specified then the current directory is to be analyzed.

@aciccarello
Copy link
Collaborator

Hello @dtgriscom. This should already be available via an (undocumented) typedocOptions object in your tsconfig.json. There is also an option to have a separate project configuration file, though this needs some work. See the discussion in #604 for more information.

I'll leave this open until the documentation issue is resolved.

@aciccarello aciccarello changed the title Allow specifying project in tsconfig.json, or have current directory be default Allow specifying typedoc options in tsconfig.json Mar 5, 2018
@aciccarello aciccarello added help wanted Contributions are especially encouraged Priority: 1 labels Mar 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants