[api-extractor] Fix error for export star from ambient module #3528
Conversation
This file contains 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
PeachScript
requested review from
iclanton,
octogonz,
apostolisms and
D4N14L
as code owners
|
|
octogonz
reviewed
Jul 20, 2022
|
|
||
| try { | ||
| starExportedModule = this._fetchSpecifierAstModule(exportStarDeclaration, exportStarSymbol); | ||
| } catch { |
There was a problem hiding this comment.
Is this catching Internal Error: getResolvedModule() could not resolve module name? That error is thrown by API Extractor's own implementation. Generally we try to avoid throwing/catching exceptions during normal successful operation.
There was a problem hiding this comment.
Yes, I explained in the PR description:
Why use
try...catch? TheTypeScriptHelpers.isAmbientcannot working for this, is there a more precise way thantry...catch?
Can you provide a better way to catch that?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Handle
export * from '<ambient module>'when rollup.d.ts.For example, there has
export * from 'fs'statement in the@types/fs-extra, and thefsis an ambient module of@types/node, we will get the following error when running api-extractor:Ref issue: #3335
Ref PR: #3339
Details
The solutions is, catch the resolve error and fallback to append a fake external
AstModule, then handle it in the_collectAllExportsRecursivemethod.Why use
try...catch? TheTypeScriptHelpers.isAmbientcannot working for this, is there a more precise way thantry...catch?How it was tested
Add
export * from 'fs'intobuild-tests/api-extractor-scenarios/src/exportStar2/index.ts, and make sure it can be rollup successfully.