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

Breaks typedoc-plugin-rename-defaults (and possibly other ESM plugins) #530

Closed
NanderTGA opened this issue Dec 21, 2023 · 3 comments
Closed

Comments

@NanderTGA
Copy link

From typedoc-plugin-rename-defaults version 0.6.7, the API docs still get generated but don't get detected by Docusaurus (both on v2 and v3) until a rebuild is triggered.
After some research on this issue (more information here), it seems that the plugin stopped working properly after they migrated to ESM.
Reproduction

@felipecrs
Copy link

To provide a little more context, @Gerrit0 from TypeDoc suggests that typedoc-plugin-markdown may not be handling all promises correctly.

Personally I don't understand how that relates to CommonJS vs ESM, but any help in troubleshooting this issue would be welcome.

A blind idea I had was to migrate typedoc-plugin-markdown to ESM as well (which I suppose would happen someday anyway), hoping it may help with the issue.

@Gerrit0
Copy link

Gerrit0 commented Dec 21, 2023

Not the markdown plugin! The docusuaurus plugin.

@tgreyuk
Copy link
Member

tgreyuk commented Dec 22, 2023

Thanks guys for all of the information. This should be fixed docusaurus-plugin-typedoc@0.22.0. As @Gerrit0 suggested ithe issue appears to be with the way the plugin was handling async stuff. Interestingly the TypeDoc async app methods were being processed correctly but not the dyamic imports of the esm plugins.

@tgreyuk tgreyuk closed this as completed Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants