split task/plugin options #569
Merged
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
apaleslimghost
changed the title
ivomurrell
requested changes
Jan 19, 2024
There was a problem hiding this comment.
looks good overall! I'll be interested to see the outcomes of the PRs to add the task options to be able to judge if the change justifies the increase in code complexity but on first glance I agree that it will make configuration less mysterious to the user.
there's a few places where we're missing behaviour parity between plugin options and task options that we'll need to copy over
| @@ -194,6 +196,8 @@ const isPartialOptional = (partial: ZodPartial): partial is z.ZodOptional<z.ZodT | |||
| typeof (partial as z.ZodOptional<z.ZodTypeAny>).unwrap === 'function' | |||
|
|
|||
| export default async ({ logger, config, toolKitConfig, configPath }: OptionsParams): Promise<boolean> => { | |||
| toolKitConfig.options.plugins = {} | |||
There was a problem hiding this comment.
issue: we should be prompting for task options at the same time as plugin options (using the same optionsPromptForPlugin function preferably)
There was a problem hiding this comment.
i'll do this after we have task options in place (#570). this doesn't feel essential for this PR
ivomurrell
force-pushed
the
next
branch
2 times, most recently
from
761ec5f to
83c4594
Compare
apaleslimghost
force-pushed
the
CPP-1852-task-vs-plugin-options
branch
from
25ff6e9 to
f3336e0
Compare
apaleslimghost
force-pushed
the
CPP-1852-task-vs-plugin-options
branch
from
f3336e0 to
4513ac6
Compare
apaleslimghost
force-pushed
the
CPP-1852-task-vs-plugin-options
branch
from
30d913f to
73ed836
Compare
apaleslimghost
force-pushed
the
CPP-1852-task-vs-plugin-options
branch
2 times, most recently
from
c6edc15 to
c365a95
Compare
apaleslimghost
force-pushed
the
update-prettier
branch
from
4f162c8 to
5f20426
Compare
ivomurrell
reviewed
Apr 9, 2024
and make schemas package exports more consistent
(and make the zod inference helper type generic)
…ema when initialising
Co-authored-by: Ivo Murrell <ivo.murrell@ft.com>
Co-authored-by: Ivo Murrell <ivo.murrell@ft.com>
apaleslimghost
force-pushed
the
CPP-1852-task-vs-plugin-options
branch
from
b8590ce to
2b0ccad
Compare
…compatible Slightly more backwards compatible
ivomurrell
approved these changes
Apr 10, 2024
ivomurrell
pushed a commit
that referenced
this pull request
Sep 5, 2024
…options split task/plugin options
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.
this PR adds support for loading task options from
.toolkitrc.ymls, validating them against (task-option-specific) schemas, and passing those into the task constructors as an argument (separate from plugin options, which has been renamed tothis.pluginOptions, and avoiding merging them with plugin options to make it clearer for task authors)this PR does not yet implement any actual task options. that's a much bigger task; i've made a start in #570.