Skip to content

Document the target runner options#1016

Open
ecraig12345 wants to merge 3 commits intomicrosoft:masterfrom
ecraig12345:worker-runner-types
Open

Document the target runner options#1016
ecraig12345 wants to merge 3 commits intomicrosoft:masterfrom
ecraig12345:worker-runner-types

Conversation

@ecraig12345
Copy link
Member

@ecraig12345 ecraig12345 commented Feb 10, 2026

Add types for constructor and target options for all built-in target runners, and update the TargetRunnerPickerOptions and TargetConfig.options docs 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 TargetRunnerPickerOptions also revealed a bug: the lack of types had allowed a naming mismatch, so nodeOptions were not actually being passed through to NpmScriptRunner... The internal function runnerPickerOptions() which formerly had the bad code has also been renamed getBuiltInRunners() for clarity.

Also update lage's own custom worker runners under scripts/workers to use the new types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant