[api-extractor] Fix an issue with preservation of triple-slash references. #5131
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
iclanton
requested review from
octogonz,
apostolisms,
D4N14L,
dmichon-msft and
patmill
as code owners
iclanton
force-pushed
the
reference-in-index
branch
from
37d9a1e to
9416201
Compare
octogonz
reviewed
Mar 1, 2025
iclanton
commented
Mar 1, 2025
common/changes/@microsoft/api-extractor/reference-in-index_2025-02-25-01-16.json
Outdated
Show resolved
Hide resolved
octogonz
reviewed
Mar 1, 2025
octogonz
approved these changes
Mar 1, 2025
Co-authored-by: Pete Gonzalez <[email protected]>
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
There is an issue where references are not collected from fies that only contain reexports.
"Include triple-slash references marked with
preserve=\"true\"from files that only contain re-exports. There was a behavior change in TypeScript 5.5, where only triple-slash references that are explicitly marked withpreserve=\"true\"are emitted into declaration files. This change adds support for placing these references in files that only contain re-exports, like the API entrypoint file."How it was tested
Added a repro and fixed it.
Impacted documentation
None.