[api-extractor] preserve ts-ignore directives on imports #5425
+163
−10
Conversation
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
stainless-em
requested review from
D4N14L,
apostolisms,
dmichon-msft,
iclanton and
octogonz
as code owners
|
@microsoft-github-policy-service agree company="Stainless Software" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Some libraries need to conditionally import types (ex. for optional peer dependencies), which requires a
@ts-ignoreannotation on the import in case the user doesn't have the dependency installed. This PR makes api-extractor preserve ts-ignore directives, which would otherwise be lost in the DTS rollup process.Details
This uses an internal typescript compiler API to be as accurate as possible without introducing a lot of new code to find directive ranges using the public API.
How it was tested
I modified the tests to cover this functionality and ran
rush test -t tag:api-extractor-tests.