Config schema
Complete reference for every field accepted by vx.config.{ts,mts,js,mjs}
and the optional workspace-level vx.workspace.{ts,mts,js,mjs}. The
authoritative TypeScript definitions live in src/config.ts and are
re-exported from @vzn/vx.
File layout
Section titled “File layout”<workspaceRoot>/├── pnpm-workspace.yaml (or: package.json with "workspaces", or bare package.json)├── vx.workspace.ts (optional, workspace-wide settings)└── packages/ └── <pkg>/ ├── package.json └── vx.config.ts (per-package task definitions)A project is discovered as a vx project by the presence of a
vx.config.* file alongside the project’s package.json. Projects
without a config are visible in the workspace graph but contribute no
tasks.
Project config
Section titled “Project config”import { defineProject } from '@vzn/vx'
export default defineProject({ tasks: { <taskName>: TaskConfig, ... },})defineProject is an identity function — it exists purely so
TypeScript narrows literal types in your config (clean autocomplete,
strict validation against the schema). It has zero runtime effect.
tasks is a Record<string, TaskConfig>. Task names are arbitrary
strings; they’re referenced by dependsOn, by cache.inputs.tasks,
and by the CLI (vx run <taskName> or vx run <pkg>#<taskName>).
TaskConfig
Section titled “TaskConfig”interface TaskConfig { description?: string // one-line blurb for the picker / --dry view exec?: ExecConfig // omit to declare a group task dependsOn?: readonly string[] // Turbo/Nx micro-syntax cache?: CacheConfig // caching is opt-in; requires `exec` sandbox?: SandboxConfig // opt-in OS sandbox; requires `exec`}A task either has an exec (it does work) or omits exec and declares
dependsOn (it’s a group task, a pure aggregator). The loader
rejects a task that has neither — a no-op standalone task is almost
always a config mistake.
description (optional)
Section titled “description (optional)”description?: stringA short one-line blurb describing what the task does. Pure metadata — no effect on caching, scheduling, or execution. Surfaced in three places:
- The interactive task picker (
vx runwith no positional in a TTY) — printed to the right of eachpkg#taskid. - The
--drytext preview — printed on a second indented line under the cache-status row. - The
--dry=jsonoutput —descriptionlives on each task entry.
test: { description: 'bun test against the tests/ tree', exec: { command: 'bun test' }, cache: { inputs: { files: ['src/**', 'tests/**'] }, outputs: { files: [] }, },}exec (optional — required for non-group tasks)
Section titled “exec (optional — required for non-group tasks)”interface ExecConfig { command: string // shell command, run from the project's dir env?: ExecEnv // optional per-task env layering persistent?: PersistentConfig // long-running task (dev server, watcher)}command is a string. Run via Bun.spawn with shell: true, so POSIX
shell semantics work directly — pipes, redirects, && chaining:
exec: { command: 'tsc -b'}exec: { command: 'gen && tsc && cp -r assets dist/'}exec: { command: 'find src -name "*.snap" | xargs rm -f'}CLI args after -- are appended to command, shell-quoted via
JSON.stringify(arg):
vx run test -- --bail --watch# child sees: bun test "--bail" "--watch"Forwarded args are folded into the cache key — different args produce distinct cache entries.
Why no multi-step commands: string[]? Per-task caching is the
right granularity for invalidation. If you’d benefit from caching each
step independently (e.g. codegen then build), split into two
tasks linked by dependsOn. If you don’t need that, && in shell is
the right tool.
persistent (optional)
Section titled “persistent (optional)”interface PersistentConfig { readyWhen?: string // regex (as string); first matching output marks ready readyTimeoutMs?: number // bound the readiness wait; requires readyWhen}Marks the task as a long-running process — a dev server, a file watcher, a daemon. The runner spawns the command but does NOT wait for it to exit. Instead it considers the task “ready”:
- Immediately on successful spawn when no
readyWhenis given. - On the first stdout/stderr output that matches the
readyWhenregex string. The match also sees a trailing partial line, so prompt-style banners without a newline (printf 'Listening on :3000') count.
dev: { exec: { command: 'vite', persistent: { readyWhen: 'Local:', readyTimeoutMs: 30_000 }, },}
watch: { exec: { command: 'tsc --watch --preserveWatchOutput', persistent: { readyWhen: 'Watching for file changes' }, },}
// No readyWhen — ready as soon as spawn succeeds. Useful for daemons// that have no observable "ready" signal but downstream doesn't need// to gate on one.agent: { exec: { command: 'my-agent --daemon', persistent: {}, },}Semantics:
- Downstream unblocks on ready, not on exit. Useful for e2e tests
that need a dev server up first:
'dev:run': { exec: { command: 'vite', persistent: { readyWhen: 'Local:' } } },'e2e': { dependsOn: ['dev:run'], exec: { command: 'playwright test' } },
- Exit before ready ⇒ failed. If the persistent task crashes or
exits before
readyWhenmatches, the task is reported asfailed. - End-of-graph SIGTERM. Once the rest of the graph finishes
(success OR failure of downstream), the orchestrator sends
SIGTERMto every persistent subprocess and waits for them to exit before returning. cacheis rejected. The config loader throws oncache + persistent— persistent tasks don’t terminate, so there’s no exit code to cache and no outputs to capture at a well-defined moment.
ExecEnv (optional)
Section titled “ExecEnv (optional)”interface ExecEnv { passThrough?: string[] // names taken from host process.env define?: Record<string, string> // explicit name=value pairs}The child process sees a deliberately limited env. From lowest to highest priority:
- Essential allowlist (hard-coded in
src/exec/env.ts):PATH,HOME,SHELL,TMPDIR,LANG,TERM,COLORTERM,FORCE_COLOR,NO_COLOR,CI,NODE_OPTIONS, plus Windows essentials likeSYSTEMROOT/USERPROFILE. Without these, typical CLI tools break. passThroughnames → value taken from hostprocess.envat spawn time. NOT folded into the cache key — for secrets, regional values, CI flags that legitimately vary between machines.define→ explicit literal values. ARE folded into the cache key via the task config hash (the values are in your config file, so they participate naturally).
exec: { command: 'bun test', env: { passThrough: ['CI', 'GH_TOKEN'], // values forwarded; cache-invariant define: { NODE_ENV: 'test' }, // literal; in the cache key },}Anything outside these three layers is invisible to the child. This
matches Turbo’s passThroughEnv semantics and exists for two reasons:
- Cache stability. If every host env var entered the key, every
shell with a different
PS1would cache-miss. - Determinism. If host env leaked into the child, two machines
with different
FOO=barset would produce different outputs and the user would never know why.
A <projectDir>/node_modules/.bin directory is automatically
prepended to PATH so locally-installed tools (oxlint, vite,
etc.) work without npx. Only the project’s own bin — not the
workspace root’s — so sibling-project bins stay invisible (project
isolation).
dependsOn (optional)
Section titled “dependsOn (optional)”Tasks that must complete successfully before this task runs. Turbo/Nx-style micro-syntax — a flat array of strings:
dependsOn?: readonly string[]| Form | Meaning |
|---|---|
'name' | Same-project task name. |
'^name' | The name task in the nearest workspace deps that declare it. |
'pkg#name' | The name task in a specific other package (cross-project edge). |
Examples:
dependsOn: ['build'] // same-project build firstdependsOn: ['^build'] // build in every workspace dep firstdependsOn: ['codegen', '^build'] // bothdependsOn: ['lib#build', 'shared#test'] // cross-project edgesSemantics:
- Same-project (
'name') — name must exist in this project’stasksmap; missing is a hard error at graph-build time. '^name'— nearest-holder frontier. Walk the package dep graph from this project’s direct deps; each path stops at the first dep that declares the task and an edge is added to it (Turbo/Nx direct-deps parity). The holder’s owndependsOnis responsible for anything deeper — chain'^name'in the holder to keep the cascade going (the universal pattern). Deps that don’t declare the task are passed through, so a sparse dep doesn’t break ordering to deeper packages that do (sparse tasks across a workspace are normal — not every package has alint).'pkg#name'— missing pkg or task is a hard error (you named them explicitly).- No wildcards or negation here.
'*'/'^*'/'!form'belong incache.inputs.tasks(filtering which upstream hashes participate in this task’s cache key), not independsOn(declaring graph edges). The micro-syntax parser rejects them in this position. - Cycle detection runs across the resolved graph at the end of
buildTaskGraph. Cycles throw with a path-formatted message.
cache (optional)
Section titled “cache (optional)”interface CacheConfig { inputs: CacheInputs // required when `cache` is provided outputs: CacheOutputs // required when `cache` is provided}Caching is opt-in. Omit cache and the task always runs (no read,
no write). Provide it and caching is active for that task. The
project loader requires both inputs and outputs when cache is
set — declaring “what does this read?” and “what does it produce?” is
a deliberate, conscious choice.
Why opt-in? Defaulting caching to ON with implicit “all files / no outputs” silently produces stale builds the moment a user forgets to revisit the config. The cost of a single forgotten cache miss (re-run a task) is much less than the cost of a stale cache hit (ship broken artifacts).
CacheInputs
Section titled “CacheInputs”interface CacheInputs { files: string[] // required workspaceFiles?: string[] // optional; workspace-root-relative env?: string[] // optional tasks?: readonly string[] // optional; same micro-syntax as dependsOn}inputs.files (required)
Section titled “inputs.files (required)”Project-relative globs. !-prefix negates.
files: ['**/*'] // all project filesfiles: ['src/**', '!**/*.test.ts'] // narrow with exclusionfiles: [] // no file inputs at allfiles: ['src/**', 'tsconfig.json', 'package.json'] // specific pathsEmpty array is valid — the cache key still incorporates command, env, upstream hashes, workspace fingerprint, and the project’s package.json. A task with no file inputs (e.g. a pure “download-and-verify”) still cache-misses on a lockfile change.
Always applied to every glob pass (regardless of what you wrote):
- gitignore filter — workspace-root + project
.gitignore. - Always-ignored —
node_modules/**,.git/**,.vx/**,*.tsbuildinfo. - Declared
outputs.filesare excluded — a task never invalidates itself via its own output. - Nested-project subtree — files belonging to a project rooted
inside this one’s dir are excluded. No cross-project leakage via
globs; the only cross-project relationship is
dependsOn+ upstream-hash propagation.
inputs.workspaceFiles (optional, default [])
Section titled “inputs.workspaceFiles (optional, default [])”Workspace-root-relative globs — the Turbo $TURBO_ROOT$ / Nx
{workspaceRoot} equivalent, for inputs that live outside the project
dir (a root tsconfig.base.json, shared codegen output, …). Same
syntax as files (! negation, last-write-wins), same git-aware
resolution (tracked + untracked-not-ignored; gitignored files are
invisible), and the resolved paths join the same cache-key file list.
inputs: { files: ['src/**'], workspaceFiles: ['tsconfig.base.json', 'shared/**', '!shared/README.md'],}No boundary rule — deliberate escape hatch. Unlike files,
workspaceFiles globs may match files anywhere in the workspace,
including inside other projects’ directories. That’s bad practice
(prefer project-relative declarations plus dependsOn + upstream-hash
propagation for cross-project relationships), but it is there for the
cases that genuinely need root-anchored inputs. The hard
project-boundary rule continues to apply to project-relative files
globs only.
Still applied: the always-ignored set (node_modules/**, .git/**,
.vx/**, *.tsbuildinfo) and the task’s own declared
outputs.workspaceFiles (a task never invalidates itself).
vx watch: when any config declares inputs.workspaceFiles, the loop
watches the workspace root recursively (any file can be an input once
boundaries are off), so root-subdir changes re-trigger cycles like any
other edit. The always-ignored set still filters the noise.
inputs.env (optional, default [])
Section titled “inputs.env (optional, default [])”Env var names whose host values are folded into the cache key.
Independent of exec.env:
- Listing a name in
exec.env.passThroughdoes NOT make its value affect the cache. - Listing a name here does NOT forward it to the child process.
To both forward AND track, list it in both places. Yes, the
double-declaration is mild noise; a preset helper
(envTracked('NODE_ENV')) can sugar it.
inputs: { files: ['src/**'], env: ['NODE_ENV', 'TARGET_BROWSER'], // changes here bust the cache}A cache-input env var the task actually reads must ALSO appear in
exec.env.passThrough (or define) — the child environment is
isolated, so without it the key varies on a value the command never
sees. Tracking-only declarations (an env var that influences inputs
some other way) are legal but rare; if in doubt, declare both.
Unset names contribute the empty string to the key — and that’s distinguishable from a name that was never listed (the count of names
- the names themselves are also in the key).
inputs.tasks (optional, default = all upstream)
Section titled “inputs.tasks (optional, default = all upstream)”Same micro-syntax as dependsOn, plus two filter-only extras:
| Form | Meaning |
|---|---|
'*' | Include every same-project upstream hash. |
'^*' | Include every dep-workspace upstream hash. |
'name' | Include same-project task name. |
'^name' | Include name in every dep workspace. |
'pkg#name' | Include the specific package’s name task. |
'!<form>' | Exclude — any of the above with a leading !. |
Patterns are applied in order; last write wins. So
['*', '^*', '!^noisy'] reads as “all upstream except deps’ noisy
task”. Defaults:
- Omitted → all upstream contribute (
['*', '^*']). Most common. []→ fully decoupled; no upstream contributes.
Examples:
tasks: ['^build'] // only ^build from deps; nothing from selftasks: ['codegen', '^*'] // self.codegen + everything from depstasks: ['*', '^*', '!^noisy'] // all upstream except deps.noisytasks: ['lib#build'] // a single cross-project hashtasks: [] // fully decoupledWhen to use this: when a task dependsOns another for ordering
(it has to run after) but the upstream’s outputs do NOT affect this
task’s outputs. Typical case: an integration-test task dependsOns
build for ordering, but its inputs are only the test source — so
inputs.tasks: [] to keep build from invalidating it.
CacheOutputs
Section titled “CacheOutputs”interface CacheOutputs { files: string[] // required workspaceFiles?: string[] // optional; workspace-root-relative}Project-relative globs of files the task produces. Captured on cache write, restored on cache hit (overwriting any local modifications), and wiped before exec AND before restore so the project dir ends every run bit-identical to the cached snapshot.
outputs: { files: ['dist/**']} // typical build outputoutputs: { files: []} // tasks with no file output (lint, test)outputs: { files: ['dist/**', 'coverage/**']}Outputs are NOT filtered through gitignore — typical artifact
dirs like dist/, coverage/, .next/, pkg/ are captured normally
even when gitignored (they usually are).
Empty [] is valid for tasks that produce no files (e.g. lint,
typecheck, test); you still cache the no-op success so the next
run is a no-op too.
Cleaning semantics (one of vx’s strict-output-ownership rules):
- Before exec on a cache miss: the declared output globs are resolved
and matching files / dirs are wiped. So a leftover
dist/old.jsfrom a prior build can’t survive into a fresh build that doesn’t rewrite it. - Before restore on a cache hit: same wipe, then files are copied from the cache entry into the project dir. The post-restore tree is the cached snapshot, byte-for-byte.
Skipped when cache.outputs.files is empty (nothing declared as
output) AND when --no-cache is set (the user is debugging and
managing the tree themselves).
outputs.workspaceFiles (optional, default [])
Section titled “outputs.workspaceFiles (optional, default [])”Workspace-root-relative globs for outputs the task writes OUTSIDE its
project dir (e.g. a root-level generated file). Same capture / restore
/ wipe semantics as files, anchored at the workspace root; packed
into the artifact under a separate workspace-outputs/<rel-to-root>
namespace so project and workspace outputs never collide.
outputs: { files: ['out.txt'], workspaceFiles: ['generated/**'],}No boundary rule — deliberate escape hatch. These globs may
capture (and on restore, overwrite; on clean, wipe) files anywhere in
the workspace, including inside other projects’ dirs. Prefer
project-relative files whenever the task can write inside its own
dir. Two tasks declaring overlapping workspace outputs is user
responsibility — vx does not police it; last restore wins.
sandbox (optional)
Section titled “sandbox (optional)”Opt a task into an OS-level sandbox. Requires exec; silently skipped for
persistent tasks. Opt-in per task — omit it and the task runs
unsandboxed. Full walkthrough in the
sandboxing guide.
interface SandboxConfig { // Filesystem — paths are project-relative / absolute / `~`-expanded. // NO globs (bwrap accepts path prefixes only). allowRead?: string[] // extra readable paths beyond resolved cache.inputs.files allowWrite?: string[] // extra writable paths beyond the cache.outputs.files prefix allowGitConfig?: boolean // permit writes to .git/config (default false)
// Network — blocked by default. network?: boolean | SandboxNetworkConfig // false (default) | true | fine-grained
// Process behavior. allowPty?: boolean // acquire a TTY (default false) enableWeakerNestedSandbox?: boolean // Linux: nested sandboxes (default false) enableWeakerNetworkIsolation?: boolean // macOS: host-proxy net, lower isolation (default false)
// Silence known-noisy probes: command-substring → paths to ignore. ignoreViolations?: Record<string, string[]>}
interface SandboxNetworkConfig { allowedDomains?: string[] // wildcards ok: `*.example.com`, `*` deniedDomains?: string[] // evaluated before allowedDomains allowUnixSockets?: string[] allowAllUnixSockets?: boolean allowLocalBinding?: boolean // bind localhost ports (e.g. a self-querying test server) allowMachLookup?: string[] // macOS only}Baseline (sandbox: {}): read only resolved cache.inputs.files,
write only the static prefix of cache.outputs.files (a task with empty
outputs writes nowhere), no network. No inheritance, no workspace
defaults, no built-in escapes — declare everything explicitly.
Policy: fail on violation. An undeclared read/write (macOS log
monitor) or a child that fails because it couldn’t reach a path (Linux
bwrap structural deny) fails the task; a failed task is never cached.
Activation is lazy (only when some task declares sandbox); on an
unsupported platform a sandboxed task fails fast rather than running
unsandboxed. Linux needs bubblewrap + socat installed.
Group tasks (no exec)
Section titled “Group tasks (no exec)”A task with no exec and a non-empty dependsOn is a group task
— a pure aggregator. Running a group is equivalent to running its
dependencies; nothing else happens (no spawn, no I/O, no cache
read/write).
// `vx run install --all` → fans out to `build` in every workspace depinstall: { description: 'build everything in workspace dependency order', dependsOn: ['^build'],}
// `vx run ci` → runs format-check + lint + test in the cwd projectci: { description: 'format-check + lint + test (CI gate)', dependsOn: ['format-check', 'lint', 'test'],}Group tasks:
- Are not counted in the run summary. “3 tasks, 2 cached” reflects real executable tasks — including a group in the count is confusing (“3 of 4 cached” when one was a group that ran nothing).
- Are not recorded in the
runstable. Analytics queries that aggregate runtime won’t see them. - Render no framed block in the live output.
- DO contribute a stable hash to downstream tasks that filter
inputs.tasksto include the group. The hash is rolled up from the group’s upstream outcomes (sorted, joined, hashed). So any change beneath the group cascades correctly.
The loader rejects:
- A task with no
execAND nodependsOn(literal no-op). - A
cacheblock on a group (nothing to cache).
Workspace config (vx.workspace.ts)
Section titled “Workspace config (vx.workspace.ts)”Loaded from vx.workspace.{ts,mts,js,mjs} at the workspace root.
Optional — when missing, every field falls back to its built-in
default.
import { defineWorkspace } from '@vzn/vx'
export default defineWorkspace({ concurrency: 8, cacheDir: 'build/.vx-cache',})interface WorkspaceConfig { /** Maximum concurrent tasks. Defaults to navigator.hardwareConcurrency. */ concurrency?: number /** Cache directory, relative to workspace root. Defaults to `.vx/cache`. */ cacheDir?: string}concurrency— used as the default cap on parallel tasks; the CLI--concurrency <n>still wins when passed.cacheDir— relative paths are resolved against the workspace root; absolute paths are used as-is.vx run,vx cache prune, and any other reader use the same resolution (src/workspace/workspace.ts:resolveCacheDir).
The loader validates the shape (positive integer for concurrency,
string for cacheDir) and throws a UserError on malformed input.
Reserved for future workspace-level features
Section titled “Reserved for future workspace-level features”These fields are anticipated but not implemented:
globalInputs— a workspace-wide file set folded into every task’s cache key (useful for shared root configs liketsconfig.base.json). Currently absent; the workspace fingerprint covers lockfile + workspace yaml but not arbitrary root files.globalEnv— workspace-wide cache-tracked env names.globalPassThrough— workspace-wide forwarded env names.namedInputs— Nx-style reusable input sets, referenced from taskcache.inputs.files. Reduces glob duplication.targetDefaults— Nx-style task-defaults inheritance.
These are listed in comparison.md as gaps.
Helpers
Section titled “Helpers”import { defineProject, defineWorkspace } from '@vzn/vx'
// Identity functions; their purpose is type inference.defineProject<T extends ProjectConfig>(config: T): TdefineWorkspace<T extends WorkspaceConfig>(config: T): TUse them so TypeScript narrows literal types in your config —
autocomplete for task names in dependsOn against your declared
tasks, strict validation against the schema, errors at edit time
rather than at vx run time.
You can skip the helpers and write
export default { tasks: { … } }, but the IDE experience is
strictly worse.
Full example
Section titled “Full example”import { defineProject } from '@vzn/vx'
export default defineProject({ tasks: { // Real cached task with file inputs, env tracking, and outputs. build: { description: 'compile TypeScript to dist/', // NODE_ENV is a cache input below, so it must reach the child // too — the exec env is isolated, not inherited. exec: { command: 'tsc -b', env: { passThrough: ['NODE_ENV'] } }, dependsOn: ['^build'], cache: { inputs: { files: ['src/**', '!**/*.test.ts', 'tsconfig.json'], env: ['NODE_ENV'], }, outputs: { files: ['dist/**'] }, }, },
// Cached, depends on upstream build; CI is in passThrough only // (CI=1 shouldn't bust the cache — it's true on every CI run). test: { description: 'run unit tests', exec: { command: 'bun test', env: { passThrough: ['CI'] } }, dependsOn: ['build'], cache: { inputs: { files: ['src/**', 'tests/**'] }, outputs: { files: [] }, }, },
// Cross-project edges. The pkg.tgz from one project's build is // cached, and depends on builds in every workspace dep. package: { description: 'pack the npm tarball', exec: { command: 'rm -rf pkg && npm pack --pack-destination ./pkg' }, dependsOn: ['build', 'test'], cache: { inputs: { files: ['package.json'], tasks: ['build', '^build'], // hash these upstream too }, outputs: { files: ['pkg/*.tgz'] }, }, },
// Persistent dev server. Downstream tasks unblock on the // "Local:" line, not on exit (which never comes). dev: { description: 'vite dev server', exec: { command: 'vite', persistent: { readyWhen: 'Local:', readyTimeoutMs: 30_000 }, env: { passThrough: ['VITE_API_URL'] }, }, },
// E2E test gated on the dev server. Together: vx run e2e runs // dev → e2e; e2e exits → orchestrator SIGTERMs dev → run ends. e2e: { description: 'end-to-end tests against dev server', exec: { command: 'playwright test' }, dependsOn: ['dev'], },
// Pure group task — `vx run ci` fans out, the group itself is // silent in the run output. ci: { description: 'format-check + lint + test', dependsOn: ['format-check', 'lint', 'test'], }, },})Common patterns
Section titled “Common patterns”Sharing inputs across tasks (today)
Section titled “Sharing inputs across tasks (today)”Until named inputs ship, copy the glob list. Plain TS arrays:
const srcInputs = ['src/**', 'tsconfig.json']
export default defineProject({ tasks: { build: { exec: { command: 'tsc' }, cache: { inputs: { files: srcInputs }, outputs: { files: ['dist/**'] } }, }, test: { exec: { command: 'bun test' }, cache: { inputs: { files: [...srcInputs, 'tests/**'] }, outputs: { files: [] } }, }, },})Presets
Section titled “Presets”A preset is a TypeScript function that returns a TaskConfig:
import type { TaskConfig } from '@vzn/vx'
export function tsBuild(opts?: { tsconfig?: string }): TaskConfig { return { description: 'compile TypeScript', exec: { command: `tsc -b ${opts?.tsconfig ?? ''}`.trim() }, cache: { inputs: { files: ['src/**', opts?.tsconfig ?? 'tsconfig.json'] }, outputs: { files: ['dist/**'] }, }, }}import { defineProject } from '@vzn/vx'import { tsBuild } from '../../presets/ts-build.ts'
export default defineProject({ tasks: { build: tsBuild(), test: { exec: { command: 'bun test' }, dependsOn: ['build'], cache: { inputs: { files: ['src/**'] }, outputs: { files: [] } }, }, },})When the preset is consumed at config-load time, it should resolve
to .ts source — see
architecture.md § Config-time imports
for the bootstrap-cycle tradeoff.
When to use cache.inputs.tasks: []
Section titled “When to use cache.inputs.tasks: []”When a dependsOn exists for ordering only, and the upstream’s
output doesn’t influence this task’s output. Common case: an
integration test that depends on a dev server starting up but whose
own inputs are just the test source.
e2e: { dependsOn: ['dev'], exec: { command: 'playwright test' }, cache: { inputs: { files: ['e2e/**'], tasks: [], // dev's hash does not affect e2e's cache identity }, outputs: { files: ['playwright-report/**'] }, },}When to use --no-cache instead of removing cache
Section titled “When to use --no-cache instead of removing cache”--no-cache is a runtime flag, not a config change. Reach for it
when:
- You suspect cache corruption and want a clean run.
- You’re benchmarking and need fresh timings.
- You’re forwarding one-off args and don’t want to pollute the cache with a one-shot key (though note: forwarded args are already in the key, so they form their own entry anyway).
It applies to the whole run; per-task opt-out belongs in config (omit
the cache block).
Schema validation errors
Section titled “Schema validation errors”The loader (src/workspace/project-loader.ts) validates at load time
and surfaces UserError (clean output, no stack):
| Symptom | Cause |
|---|---|
did not export a default object | Forgot export default, or exported a non-object. |
tasks must be an object | tasks field is missing or not an object. |
tasks.<name> must be an object | The task value is null / a string / etc. |
exec must be an object with a command string | exec is malformed. |
exec.command must be a non-empty string | Forgot command, or empty string. |
exec.persistent must be an object (or omitted) | Wrong shape. |
exec.persistent.readyWhen must be a string regex | Non-string readyWhen. |
cache is not allowed on a persistent task | persistent + cache combined. |
a task with no exec must declare dependsOn | Group task with no edges. |
cache requires exec | Group task with cache. |
dependsOn must be an array of strings | Wrong shape. |
cache.inputs is required when cache is set | Forgot inputs. |
cache.inputs.files must be an array | Wrong shape. |
cache.outputs is required when cache is set | Forgot outputs. |
cache.outputs.files must be an array | Wrong shape. |
description must be a string | Non-string description. |
Workspace-config errors:
| Symptom | Cause |
|---|---|
concurrency must be a positive integer | concurrency is negative, zero, NaN, … |
cacheDir must be a string | Wrong shape. |