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: fix docs for @theia/plugin #10274

Merged
merged 1 commit into from
Nov 2, 2021
Merged

Conversation

vince-fugnitto
Copy link
Member

What it does

Fixes: #10227

The pull-request fixes the generated typedoc documentation for the @theia/plugin extension including theia.d.ts and theia-proposed.d.ts following a breaking change in typedoc regarding modules:

Version 0.20 completely reworks how documentation is generated by TypeDoc. In previous versions, there was --mode file and --mode modules, which documented files according to their content on the filesystem. This worked reasonably well before ES modules were commonly used, but was insufficient for the modern ecosystem. In 0.20, TypeDoc documents your project according to what you export.

How to test

1, confirm that plugins still work correctly
2. confirm that typings for theia.d.ts and theia-proposed.d.ts works correctly
3. performing a yarn docs should now generate the typedoc correctly for @theia/plugins (both theia.d.ts and theia-proposed.d.ts combined) - note export NODE_OPTIONS=--max-old-space-size=8196 may be necessary:

image

Review checklist

Reminder for reviewers

Signed-off-by: vince-fugnitto [email protected]

The commit fixes the missing documentation generation for
`@theia/plugin` including `theia-proposed.d.ts` and `theia.d.ts`.

Signed-off-by: vince-fugnitto <[email protected]>
@vince-fugnitto vince-fugnitto added documentation issues related to documentation plug-in system issues related to the plug-in system labels Oct 14, 2021
@vince-fugnitto vince-fugnitto self-assigned this Oct 14, 2021
@vince-fugnitto
Copy link
Member Author

@tsmaeder did you have any feedback of how we now generate the typedocs for @theia/plugin?

@vince-fugnitto
Copy link
Member Author

Ping :)

Copy link
Contributor

@tsmaeder tsmaeder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc for the plugins package now generates fine.

@vince-fugnitto vince-fugnitto merged commit e91bea4 into master Nov 2, 2021
@vince-fugnitto vince-fugnitto deleted the vf/plugins-typedoc branch November 2, 2021 13:14
@vince-fugnitto vince-fugnitto added this to the 1.20.0 milestone Nov 2, 2021
@vince-fugnitto vince-fugnitto mentioned this pull request Aug 30, 2022
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation plug-in system issues related to the plug-in system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Empty doc github page for module @theia/plugin
2 participants