[api-extractor] Allow omission of import statements in API reports #4756
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
Josmithr
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
|
Nit: Spelling in title 'omission'? |
Josmithr
changed the title
|
This link was an error. Please disregard. |
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
Add a config option for omitting import statements from API reports.
Details
Especially when combined with the new
reportVariantsfunctionality, the import statements included in the reports by default may or may not actually reflect the set of imports used by the (reduced) set of exports included in the report.Additionally, for reviewing / API change monitoring, including the import statements can create unwanted noise in PR reviews.
The new
includeImportsreport config option is optional, and defaults totrueto preserve existing behavior.How it was tested
Updated one of the test suite configurations to omit imports. See updated test collateral.
Impacted documentation
This page may want to be updated to call out the new optional config parameter:
https://api-extractor.com/pages/setup/configure_api_report/