docs: add typedoc-plugin-missing-exports#109
Open
moshams272 wants to merge 1 commit into
Open
Conversation
- Added plugin to recover internally referenced but unexported types. - Set excludeExternals: true to filter out Node/language built-ins. - Successfully recovered ~60 Webpack-specific internal types.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
avivkeller
requested changes
May 26, 2026
Member
avivkeller
left a comment
avivkeller
left a comment
There was a problem hiding this comment.
I think we should find a new home for these types, rather than <internal>. Similarly to how #91 added a system for moving types to the subsystems that they are actually used in, can we do that here>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Integrates
typedoc-plugin-missing-exportsto recover internally used types/interfaces that were not explicitly exported, resolving missing references in the docs.I tried three different settings to find the best result:
Experiment 1: Default Plugin Behavior (~135 types)
Running the plugin with default settings recovered about 135 missing types. However, they were isolated in an
<internal>module thattypedocdidn't go throw them (Shallow Pass).Experiment 2: Using
excludeExternals: true(~60 types) -> [Current PR State]I added this option to ignore basic JavaScript/Node types. The number dropped to about 60 Webpack types. They are grouped in an
<internal>folder. I chose this approach because it keeps the docs clean and simple.Experiment 3: Using
excludeExternals: true&placeInternalsInOwningModule: true(~630 types)I tried this option to put the types inside their original modules instead of the
<internal>folder. But this made the plugingo into chain, as after get them out it started seaching to the internally used types/interfaces that were not explicitly exported and put them inside their original modules and do it again to them...
While highly detailed, I felt the 630+ inline types would create too much noise for the average reader, so I reverted to Experiment 2.
Fixes #92