Problem
vp run supports passing extra args after the task name (they are forwarded to the task command), but Vite Tasks does not appear to provide a first-class mechanism to:
- declare an argument schema (types/choices/default/help/env),
- validate arguments,
- generate
--help for a task,
- and/or expose argument values to the task definition in a structured way so tasks can branch predictably.
This makes common patterns (deploy targets, feature flags, region selection, dry-run, etc.) rely on ad-hoc shell parsing and reduces discoverability.
Evidence (primary)
- Vite+ docs: extra args after the task name are passed to the task command.
(see vp run docs)
- Plan implementation:
extra_args are appended only to the last &&-split command (pass-through model), not parsed/typed.
- Task config schema appears command-centric and doesn’t show an args/usage-like field.
Use cases
deploy <env> where env is one of dev|staging|prod (typed choices)
--region, --dry-run, --verbose with defaults and validation
- Better UX:
vp run deploy --help to show a task-specific help screen
- Avoid duplicating many similar tasks just to vary a parameter
Proposed behavior (Unspecified syntax; proposal is conceptual)
Allow task definitions to optionally declare an argument schema, e.g. (example only):
- positional args with enum choices
- flags and options with types, defaults, help text, and env fallbacks
Then, at runtime:
- validate inputs before execution
- expose parsed values to the task as env vars (MVP) or templating variables (future)
- generate task-level help (
vp run <task> --help), without breaking existing pass-through
Backward compatibility
- If a task has no arg schema, behavior remains exactly the same (current pass-through).
- If a schema exists, only then enable validation/help/env injection.
- Preserve
-- semantics (Unspecified; needs design) to avoid collisions between runner flags and task flags.
Minimal implementation suggestion (MVP)
- Add optional
args/usage metadata to the task schema (no runtime behavior yet).
- Parse task args for tasks that opt in; inject values into env as
VP_ARG_<name> (or similar).
- Implement
--help generation from the schema for opt-in tasks.
- Later: allow templating/branching semantics based on parsed args.
Prior art
Problem
vp runsupports passing extra args after the task name (they are forwarded to the task command), but Vite Tasks does not appear to provide a first-class mechanism to:--helpfor a task,This makes common patterns (deploy targets, feature flags, region selection, dry-run, etc.) rely on ad-hoc shell parsing and reduces discoverability.
Evidence (primary)
(see
vp rundocs)extra_argsare appended only to the last&&-split command (pass-through model), not parsed/typed.Use cases
deploy <env>where env is one ofdev|staging|prod(typed choices)--region,--dry-run,--verbosewith defaults and validationvp run deploy --helpto show a task-specific help screenProposed behavior (Unspecified syntax; proposal is conceptual)
Allow task definitions to optionally declare an argument schema, e.g. (example only):
Then, at runtime:
vp run <task> --help), without breaking existing pass-throughBackward compatibility
--semantics (Unspecified; needs design) to avoid collisions between runner flags and task flags.Minimal implementation suggestion (MVP)
args/usagemetadata to the task schema (no runtime behavior yet).VP_ARG_<name>(or similar).--helpgeneration from the schema for opt-in tasks.Prior art
usageschema + help + env injection + templated branching:https://mise.jdx.dev/tasks/task-arguments.html
https://just.systems/man/en/recipe-parameters.html