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

stripInternal no longer recognized #1469

Closed
dbartholomae opened this issue Jan 16, 2021 · 3 comments
Closed

stripInternal no longer recognized #1469

dbartholomae opened this issue Jan 16, 2021 · 3 comments
Labels
bug Functionality does not match expectation

Comments

@dbartholomae
Copy link

dbartholomae commented Jan 16, 2021

Search terms

stripInternal strip-internal

Expected Behavior

Calling typedoc with stripInternal set in typedoc.json should build documentation.

Actual Behavior

Error: Tried to set an option (stripInternal) that was not declared. and building fails

Steps to reproduce the bug

You can see it in my open-source repo. Here's the config file:
https://github.com/dbartholomae/jsx-readme/blob/main/typedoc.json

This broke somewhere between 0.19.2 and 0.20.14.
With 0.19.2 the code worked:
https://github.com/dbartholomae/jsx-readme/runs/1713979422?check_suite_focus=true#step:11:6

But after updating to 0.20.14, it fails:
https://github.com/dbartholomae/jsx-readme/pull/62/checks?check_run_id=1713999146#step:11:6

Environment

  • Typedoc version: 0.20.14
  • TypeScript version: 4.0.2
  • Node.js version: 12.20.1
  • OS: Ubuntu 18.04.5
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 16, 2021

stripInternal is a TypeScript option (https://www.typescriptlang.org/tsconfig#stripInternal). In 0.20, TypeDoc dropped support for setting TypeScript options via TypeDoc config files.

However, given that it is marked as an internal option, it seems reasonable to me to add it as a TypeDoc option, and treat that option as on if either the compiler option or the TypeDoc option is on.

@dbartholomae
Copy link
Author

Nice, I did not know that this is a TypeScript option. Will read up on it, from my side the issue could be closed then, but of course feel free to use it to track the idea to pass it through.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 16, 2021

0.20.15 includes excludeInternal (renamed to match the other exclude TypeDoc options). It will be set to true automatically if you set the TypeScript stripInternal option, or can be set explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants