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

TypeDoc 0.24.x support #31

Closed
Maximvdw opened this issue Apr 14, 2023 · 2 comments
Closed

TypeDoc 0.24.x support #31

Maximvdw opened this issue Apr 14, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@Maximvdw
Copy link

The plugin does not seem to support typedoc 0.24.x and gives the error:
" Tried to set an option (umlClassDiagram) that was not declared"

0.23.x works perfectly fine

@krisztianb
Copy link
Owner

krisztianb commented Apr 14, 2023

To me it sounds like the plugin is not loaded and therefore TypeDoc doesn't like the option passed to it.

Update: confirmed on https://github.com/TypeStrong/typedoc/releases/tag/v0.24.0

TypeDoc will no longer automatically load plugins from node_modules. Specify the --plugin option to indicate which modules should be loaded.

To fix this add the parameter --plugin typedoc-umlclass to the command that calls TypeDoc.

Nevertheless I should update the plugin to get rid of the peer dependency warning displayed by NPM when updating TypeDoc to 0.24.

@krisztianb
Copy link
Owner

Peer dependency warning fixed in new version 0.7.1. Enjoy. 🥳

@krisztianb krisztianb added the enhancement New feature or request label Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants