Fix extractDocs for re-exported (aliased) symbols - #55
Merged
Conversation
Packages like @reduxjs/toolkit and @mui/material use barrel exports
(e.g. `export { createSlice } from './createSlice'`). These symbols
have SymbolFlags.Alias and no direct valueDeclaration, causing
extractDocs to fall through to findSymbolInJavaScriptFile which fails
on .d.ts files.
Fix: resolve aliases via checker.getAliasedSymbol() before checking
the declaration type. This recovers the original FunctionDeclaration/
ClassDeclaration and its full documentation.
Tests extractDocs against a barrel file that re-exports functions, classes, enums, and interfaces. Verifies that documentation, kind, and member access all work through the alias chain.
Contributor
|
@emzo thank you! Can you please run the linter/formatter? |
Contributor
Author
|
Of course. Apologies, I forgot that step! |
Contributor
Author
|
That's now done @josevalim |
Split Result (interface) into a separate `export type` to satisfy tsc --noEmit with verbatimModuleSyntax enabled.
Contributor
|
💚 💙 💜 💛 ❤️ |
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.
Summary
extractDocsfails for symbols that are re-exported through barrel files (e.g.@reduxjs/toolkit:createSlice,@mui/material:Button), even thoughgetSourceLocationworks fine for the same references.SymbolFlags.Aliasand no directvalueDeclaration. The existing declaration-type checks inextractDocsdon't account for this, causing the symbol to fall through tofindSymbolInJavaScriptFilewhich fails on.d.tsfiles.checker.getAliasedSymbol()before checking the declaration type. This recovers the original declaration and its full documentation.This affects most of the npm ecosystem — any package using barrel re-exports (
export { X } from './X').Test plan
reexport-source.ts+reexport-barrel.ts) with a barrel file that re-exports functions, classes, enums, and interfaces