[api-extractor] Support customizing defaults when loading config #4345
+88
−9
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
dmichon-msft
requested review from
iclanton,
octogonz,
apostolisms and
D4N14L
as code owners
octogonz
requested changes
Sep 25, 2023
| @@ -16,22 +17,40 @@ function expectEqualPaths(path1: string, path2: string): void { | |||
|
|
|||
| // Tests for expanding the "<lookup>" token for the "projectFolder" setting in api-extractor.json | |||
| describe(`${ExtractorConfig.name}.${ExtractorConfig.loadFileAndPrepare.name}`, () => { | |||
| it.only('config-lookup1: looks up ./api-extractor.json', () => { | |||
There was a problem hiding this comment.
🫢 We need an ESLint rule to forbid it.only() from getting merged accidentally
(not in this PR of course)
| apiExtractorPackage.ExtractorConfig.loadFile(apiExtractorConfigurationFilePath); | ||
| apiExtractorPackage.ExtractorConfig.loadFile(apiExtractorConfigurationFilePath, { | ||
| apiReport: { | ||
| reportTempFolder: taskSession.tempFolderPath |
There was a problem hiding this comment.
Couldn't we simply set reportTempFolder in api-extractor.json in the rig?
(Generally we aim for the config file is meant to represent the tool's configuration, not an input to a mysterious black box that produces the actual configuration.)
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
Adds the ability for tools consuming API-Extractor to customize the default values when loading config files.
Details
Provided custom defaults override global defaults, then the config file values are written on top of them.
Uses this ability in heft-api-extractor-plugin to change the default API report temp folder in the Heft task temp folder.
How it was tested
Added unit test for config file custom defaults.
Validated new location for temp api.md file in rushstack projects.
Impacted documentation
Currently none, unless something mentions the path to which heft-api-extractor-plugin writes its temp files.