Task runnerConfiguration

Configuration

Full reference for all task runner options

Configuration

All options are passed to defaultTaskRunner as the second argument.

Caching

Option	Type	Default	Description
`cacheDirectory`	`string`	`.task-runner-cache`	Cache storage directory
`maxCacheSize`	`string`	unlimited	Max cache size (e.g., `"1GB"`)
`maxCacheAge`	`number`	7 days (ms)	Max cache entry age
`skipNxCache`	`boolean`	`false`	Skip reading from cache
`dryRun`	`boolean`	`false`	Compute hashes without executing
`cacheDiagnostics`	`boolean`	`false`	Log cache miss reasons

Inputs

Option	Type	Default	Description
`namedInputs`	`NamedInputs`	`{}`	Named input definitions
`targetDefaults`	`Record`	`{}`	Default target configurations
`envVars`	`string[]`	`[]`	Env vars to include in hash
`globalInputs`	`string[]`	lockfiles + tsconfig.base.json + tsconfig.json + .env	Files that bust all caches
`globalEnv`	`string[]`	`[]`	Env vars that bust all caches
`smartLockfileHashing`	`boolean`	`false`	Per-package lockfile hashing
`frameworkInference`	`boolean`	`false`	Auto-detect framework env vars

Auto-Fingerprinting

Option	Type	Default	Description
`autoFingerprint`	`boolean`	`false`	Enable auto-fingerprinting mode
`fingerprintEnvPatterns`	`string[]`	`[]`	Env var patterns to fingerprint
`untrackedEnvVars`	`string[]`	`[]`	Env vars to exclude from fingerprint

Execution

Option	Type	Default	Description
`parallel`	`number \| boolean`	`3`	Max parallel tasks

Remote Cache

Option	Type	Default	Description
`remoteCache.url`	`string`	-	Cache server URL
`remoteCache.token`	`string`	-	Auth token
`remoteCache.teamId`	`string`	-	Team/namespace
`remoteCache.read`	`boolean`	`true`	Enable remote reads
`remoteCache.write`	`boolean`	`true`	Enable remote writes

Output

Option	Type	Default	Description
`summarize`	`boolean`	`false`	Generate JSON run summary

On this page

Auto-Fingerprinting

Support

Contribute to our work and keep us going

Community is the heart of open source. The success of our packages wouldn't be possible without the incredible contributions of users, testers, and developers who collaborate with us every day.Want to get involved? Here are some tips on how you can make a meaningful impact on our open source projects.

Ready to help us out?

Be sure to check out the package's contribution guidelines first. They'll walk you through the process on how to properly submit an issue or pull request to our repositories.

Submit a pull request

Found something to improve? Fork the repo, make your changes, and open a PR. We review every contribution and provide feedback to help you get merged.

Good first issues

Simple issues suited for people new to open source development, and often a good place to start working on a package.

View good first issues