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

What is compilerOptions for? #2143

Closed
mikelehen opened this issue Jan 16, 2023 · 2 comments
Closed

What is compilerOptions for? #2143

mikelehen opened this issue Jan 16, 2023 · 2 comments
Labels
question Question about functionality

Comments

@mikelehen
Copy link

The docs say:

compilerOptions
Used to selectively override compiler options for generating documentation. Values set with this option will override options read from tsconfig.json.

And there is an example of overriding strictNullChecks. But what does it mean to override strictNullChecks for typedoc? I wouldn't expect a documentation generator to be doing null checks, so I wouldn't expect that to have any effect. In general I am curious why this option exists / when you would use it. The docs / example are confusing to me as-is.

@mikelehen mikelehen added the question Question about functionality label Jan 16, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 18, 2023

#1891 - the original implementing PR has a use case.

TypeDoc uses type information, so it runs the TS compiler. It can be useful to be able to configure it with different options than are present in the tsconfig

@Gerrit0 Gerrit0 closed this as completed Feb 26, 2023
mikelehen added a commit to mikelehen/typedoc-site that referenced this issue Mar 4, 2023
See TypeStrong/typedoc#2143 for context.  I found it confusing to be setting TypeScript compiler options on a doc generator. Hopefully my edit will make it a little clearer / help people find appropriate context in the context.  Feel free to reject if you're not a fan. No biggie.
@mikelehen
Copy link
Author

Thanks for the explanation! Sorry for not acknowledging it earlier. I wanted to create a PR against the docs, but was super slow to do so. Feel free to accept or reject as you see fit.

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