Repository navigation
feat(config): group task cache fields under cache - #749
Merged
Merged
Conversation
Task cache settings now live in a `cache` object:
`cache: { env, untrackedEnv, input, output }`. `cache: true` and an omitted
`cache` are equivalent to `cache: {}`, and `cache: false` still disables
caching.
The previous top-level `env`, `untrackedEnv`, `input`, and `output` fields
keep working. They are marked `@deprecated` in the generated TypeScript
types, and loading the task graph prints one warning listing the deprecated
fields and the affected tasks. Both forms resolve to the same cache config,
so switching forms does not invalidate existing cache entries. Combining a
`cache` object with top-level cache fields fails to deserialize.
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
fspy benchmarklinuxmacoswindows |
wan9chi
marked this pull request as draft
September 22, 2026 18:13
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Member
|
LGTM |
Task cache settings are now only accepted under `cache`. Top-level `env`, `untrackedEnv`, `input`, and `output` are rejected as unknown fields instead of being accepted with a deprecation warning. Vite+ will migrate existing configs. `cache` is now a plain optional field of `UserTaskOptions`, and `UserTaskConfig` rejects unknown fields directly. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Top-level `env`, `untrackedEnv`, `input`, and `output` previously failed with a generic "data did not match any variant of untagged enum" error. They are now parsed as presence flags, and loading the task graph fails with one error that lists every affected task and points to `vp migrate` and https://viteplus.dev/config/run. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
wan9chi
added this pull request to stack #751
September 23, 2026 11:52
Move `TopLevelCacheFields`, its presence deserializer, the load error, and the per-task collection used by `IndexedTaskGraph::load` into `config::user::top_level_cache_fields`, so the migration check lives in one place and is easy to remove later. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
…-fields # Conflicts: # CHANGELOG.md
…ny>` Replace the custom presence deserializer and bool flags with `Option<IgnoredAny>`, and drop the unused `Eq` derive from `UserTaskConfig` and `UserTaskDefinition`, since `IgnoredAny` isn't `Eq`. A top-level field set to `null` now counts as not set, which matches what `null` meant before these fields moved under `cache`. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
wan9chi
marked this pull request as ready for review
September 24, 2026 02:10
wan9chi
added a commit
to voidzero-dev/vite-plus
that referenced
this pull request
Sep 25, 2026
Bumps vite-task from `790b152` to `7d69d65`. Changelog: voidzero-dev/vite-task@790b152...7d69d65#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed ## Changes from vite-task - **Changed** A task's cache settings now go inside `cache`, e.g. `cache: { env: ["NODE_ENV"], input: ["src/**"] }`. `cache: true` is the same as `cache: {}`. Top-level `env`, `untrackedEnv`, `input`, and `output` are rejected with an error that points to `vp migrate` ([voidzero-dev/vite-task#749](voidzero-dev/vite-task#749)). - **Fixed** On Windows, environment variable names used by `vp run` match regardless of ASCII letter case ([voidzero-dev/vite-task#747](voidzero-dev/vite-task#747)). - **Fixed** Cached tasks on macOS no longer intermittently fail with `oils I/O error (main): No such process` ([voidzero-dev/vite-task#703](voidzero-dev/vite-task#703)). ## Changes in this PR - `Session::init_with`, `ScriptCommand::envs`, and `SyntheticPlanRequest::envs` now key environment variables by `vt_casefold::EnvName`. The `vite-plus-cli` env maps use the same key type (`EnvMap`), so PATH lookup and env merging follow the platform rules. The hand-written case-insensitive PATH lookups are replaced by `vt::get_path_env`. - Adds `vt_casefold` as a workspace dependency, including the commented local `[patch]` entry. - Regenerates `packages/cli/src/run-config.ts`. - Moves top-level task cache fields under `cache` in CLI snapshot fixtures and a `vp_static_config` test. - Keeps `docs/vite.config.ts` in the old format. Docs deploys build it with the released `vp` from `setup-vp`, and that version rejects a `cache` object. #2814 pins that `vp` version for docs builds, so the first release with this vite-task doesn't break them. - Documents the `cache` object in `docs/config/run.md`. `env`, `untrackedEnv`, `input`, and `output` become `cache.env`, `cache.untrackedEnv`, `cache.input`, and `cache.output`. Updates the examples and links in the cache, run, and automatic data tracking guides and the READMEs. The docs describe only the `cache` object and don't mention the old top-level fields. `vp migrate` support for moving these fields comes in the next PR in this stack.
wan9chi
added a commit
to voidzero-dev/vite-plus
that referenced
this pull request
Sep 26, 2026
Task cache settings now live under `cache`, and `vp migrate` moves existing task settings for you. `vp lint` and `vp fmt` run from a package directory now pick the same config as your editor, and piped `vp` output exits cleanly. ### Breaking Changes Task cache settings in `run.tasks` now go inside `cache` ([#2813](#2813), [#2814](#2814), [#2823](#2823), [vite-task#749](voidzero-dev/vite-task#749)), by @wan9chi. | Old (top level of a task) | New | | --- | --- | | `env` | `cache.env` | | `untrackedEnv` | `cache.untrackedEnv` | | `input` | `cache.input` | | `output` | `cache.output` | `cache: true` is the same as `cache: {}`. After upgrading, a task that still uses the old top-level fields fails with an error that points to `vp migrate`. Run `vp migrate` to move the fields in `vite.config.*` for the workspace root and every package. It warns about tasks in `vite.config.*` that it cannot rewrite safely. Tasks created in other modules, such as by a shared helper function, are not detected, so move their fields by hand; the error lists every task that still needs it. Projects whose tasks do not use these fields need no changes. See the [task cache migration rules](https://viteplus.dev/guide/migrate-rules#task-cache-configuration) and the [`cache` reference](https://viteplus.dev/config/run#cache). ### Highlights - `vp lint` and `vp fmt` run from a package directory now use the same config as Oxlint, Oxfmt, and the language server, so results match your editor. `vp check` still applies the workspace-root settings ([#2807](#2807)), by @fengmk2. - Global `vp` commands now exit cleanly when piped into a command that closes early, such as `vp --version | head -n 1`, instead of aborting with exit code 134 ([#2785](#2785), [#2793](#2793)), by @naokihaba. - Cached tasks on macOS no longer intermittently fail with `oils I/O error (main): No such process` ([vite-task#703](voidzero-dev/vite-task#703)), by @lifeiscontent. ### Features - The bundled tools update `vite@8.3.0` -> `vite@8.3.1`, `rolldown@1.2.9` -> `rolldown@1.2.11`, and `oxlint-tsgolint@7.0.2002` -> `oxlint-tsgolint@7.0.2003` ([#2805](#2805), [#2812](#2812)), by @voidzero-guard[bot]. ### Fixes & Enhancements - Async `defineConfig` callbacks now type-check lint and format options, such as `'warn'` rule severities, the same way as synchronous callbacks, so configs updated by `vp migrate` no longer fail with `TS2769` ([#2803](#2803)), by @TheAlexLichter. - `vp test --help` now lists the Vitest 5 options `--repeats`, `--injectCjsGlobals`, `--fsModuleCache`, `--fsModuleCachePath`, and `--sharedViteServer` ([#2809](#2809)), by @Marve10s. - On Windows, `vp run` now matches environment variable names regardless of letter case ([vite-task#747](voidzero-dev/vite-task#747)), by @wan9chi. ### Docs - The copy prompt dialog no longer nests scroll areas and shows clearer copy feedback ([#2794](#2794), [#2799](#2799)), by @liangmiQwQ and @Boshen. ### Chore - Snapshot tests share prepared packages and one Chromium process, run faster on every platform, and no longer read the live npm registry in the standalone npm fallback case ([#2771](#2771), [#2786](#2786), [#2797](#2797)), by @fengmk2 and @voidzero-guard[bot]. - The snapshot setup check links the local `vite-plus` package into its reference home instead of installing the version under release from npm, so it passes before that version is published ([#2819](#2819)), by @wan9chi. - The preview migration harness installs a project's committed dependencies before running `vp migrate`, so the Vitest 5 migration can read the original Vitest version ([#2822](#2822)), by @wan9chi. - The standalone install workflow loads the generated environment before running `vp env doctor` ([#2790](#2790)), by @naokihaba. ### Bundled Versions | Tool | Version | Source | | --- | --- | --- | | vite | `8.3.1` | [`39ddf7c`](vitejs/vite@39ddf7c) | | rolldown | `1.2.11` | [`8df4219`](rolldown/rolldown@8df4219) | | tsdown | `0.23.0` | [npm](https://npmx.dev/package/tsdown/v/0.23.0) | | vitest | `5.0.1` | [npm](https://npmx.dev/package/vitest/v/5.0.1) | | oxlint | `1.85.0` | [npm](https://npmx.dev/package/oxlint/v/1.85.0) | | oxlint-tsgolint | `7.0.2003` | [npm](https://npmx.dev/package/oxlint-tsgolint/v/7.0.2003) | | oxfmt | `0.70.0` | [npm](https://npmx.dev/package/oxfmt/v/0.70.0) | ### Upgrade ```bash vp upgrade ``` ### New Contributors @Marve10s **Full Changelog**: v1.0.0-rc.0...v1.0.0-rc.1 --- Merging this PR will trigger the release workflow. --------- Co-authored-by: voidzero-guard[bot] <278573678+voidzero-guard[bot]@users.noreply.github.com> Co-authored-by: wan9chi <me@wan9chi.com>
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.
Motivation
env,untrackedEnv,input, andoutputonly apply when caching is enabled, but that isn't obvious when they sit at the top level of a task next to unrelated fields such ascommand,cwd, anddependsOn. For example,envreads like it sets or passes environment variables for every run, not like a cache setting. Grouping these fields undercachemakes the relationship explicit:It also gives future cache settings a place to go. For example, the upcoming remote cache option can be added as
cache: { remote: ... }instead ofcache: true, remoteCache: ....Summary
cacheomitted,cache: true,cache: {}cache: { env, untrackedEnv, input, output }cache: falseenv/untrackedEnv/input/outputcacheacceptstrue,false, or an object.cache: {}enables caching with all default settings, andcache: trueor an omittedcachemeans the same thing.env,untrackedEnv,input, andoutputare no longer accepted at the top level of a task.Migration
We'll add migration logic in vite-plus that moves top-level
env,untrackedEnv,input, andoutputintocache, and the vite-plus changelog will ask users to migrate.Configs that still use the top-level fields fail with one error that lists every affected task and points to
vp migrateand the config docs: