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

Please provide a full CLI example usage of the "compilerOptions" option. #2337

Closed
goldingdamien opened this issue Jul 14, 2023 · 3 comments
Closed
Labels
question Question about functionality

Comments

@goldingdamien
Copy link

Search terms

compilerOptions option CLI example.

Question

"compilerOptions" is provided as a way, I assume, to override individual compiler options.
However, the documentation does not make it very clear, how to use it.
Does it take JSON? A path? A single property?
Please provide a full example using CLI.

Regards.

@goldingdamien goldingdamien added the question Question about functionality label Jul 14, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 14, 2023

It cannot be specified on the command line, only via a config file

@goldingdamien
Copy link
Author

Thank you.
Do you mean it is referring to using in tsconfig.json#typedocOptions.compilerOptions only, as mentioned in #1891 ?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 16, 2023

Either tsconfig.json, or typedoc.json, the example on the site assumes typedoc.json, but it looks like I forgot to make a comment about that, updated with TypeStrong/typedoc-site@d3dd406

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants