Document the target runner options#1016
Open
ecraig12345 wants to merge 3 commits intomicrosoft:masterfrom
Open
Document the target runner options#1016ecraig12345 wants to merge 3 commits intomicrosoft:masterfrom
ecraig12345 wants to merge 3 commits intomicrosoft:masterfrom
Conversation
af280cb to
16b3e4a
Compare
16b3e4a to
4076fcc
Compare
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
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.
Add types for constructor and target options for all built-in target runners, and update the
TargetRunnerPickerOptionsandTargetConfig.optionsdocs to at least tell what the proper types are for a given target. (Fixing this properly would likely require a much more complicated setup with generic types for each built-in runner and any custom runners...)Adding constructor options types and using them when generating the default
TargetRunnerPickerOptionsalso revealed a bug: the lack of types had allowed a naming mismatch, sonodeOptionswere not actually being passed through toNpmScriptRunner... The internal functionrunnerPickerOptions()which formerly had the bad code has also been renamedgetBuiltInRunners()for clarity.Also update lage's own custom worker runners under
scripts/workersto use the new types.