@turbo/types 2.8.17-canary.8 → 2.8.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@turbo/types",
3
- "version": "2.8.17-canary.8",
3
+ "version": "2.8.17",
4
4
  "description": "Turborepo types",
5
5
  "homepage": "https://turborepo.dev",
6
6
  "bugs": {
@@ -257,6 +257,11 @@
257
257
  "description": "Opt into breaking changes prior to major releases, experimental features, and beta features.\n\nNote: Currently all previous future flags (turboExtendsKeyword, nonRootExtends) have been graduated and are now enabled by default.",
258
258
  "type": "object",
259
259
  "properties": {
260
+ "affectedUsingTaskInputs": {
261
+ "description": "Use task-level `inputs` globs to determine which tasks are affected by changed files when running with `--affected`. When enabled, only tasks whose declared inputs match the changed files are selected, rather than selecting all tasks in changed packages.",
262
+ "default": false,
263
+ "type": "boolean"
264
+ },
260
265
  "errorsOnlyShowHash": {
261
266
  "description": "When using `outputLogs: \"errors-only\"`, show task hashes when tasks complete successfully. This provides visibility into which tasks are running without showing full output logs.",
262
267
  "default": false,
@@ -271,6 +276,11 @@
271
276
  "description": "Enforce a minimum length of 32 bytes for `TURBO_REMOTE_CACHE_SIGNATURE_KEY` when `remoteCache.signature` is enabled. Short keys weaken the HMAC-SHA256 signature, making brute-force tag collision feasible.",
272
277
  "default": false,
273
278
  "type": "boolean"
279
+ },
280
+ "watchUsingTaskInputs": {
281
+ "description": "Use task-level `inputs` globs to determine which tasks to re-run when files change in `turbo watch`. When enabled, only tasks whose declared inputs match the changed files are re-executed, rather than re-running all tasks in changed packages.",
282
+ "default": false,
283
+ "type": "boolean"
274
284
  }
275
285
  }
276
286
  },
@@ -1,398 +1,631 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$ref": "#/definitions/Schema",
4
- "definitions": {
5
- "Schema": {
3
+ "title": "RawTurboJson",
4
+ "description": "Configuration schema for turbo.json.\n\nAn object representing the task dependency graph of your project. turbo interprets these conventions to schedule, execute, and cache the outputs of tasks in your project.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration",
5
+ "type": "object",
6
+ "properties": {
7
+ "$schema": {
8
+ "description": "JSON Schema URL for validation.",
9
+ "anyOf": [
10
+ {
11
+ "$ref": "#/definitions/String"
12
+ },
13
+ {
14
+ "type": "null"
15
+ }
16
+ ]
17
+ },
18
+ "boundaries": {
19
+ "description": "Configuration for `turbo boundaries`.\n\nAllows users to restrict a package's dependencies and dependents.",
20
+ "anyOf": [
21
+ {
22
+ "$ref": "#/definitions/BoundariesConfig"
23
+ },
24
+ {
25
+ "type": "null"
26
+ }
27
+ ]
28
+ },
29
+ "cacheDir": {
30
+ "description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cachedir",
31
+ "anyOf": [
32
+ {
33
+ "$ref": "#/definitions/String"
34
+ },
35
+ {
36
+ "type": "null"
37
+ }
38
+ ]
39
+ },
40
+ "concurrency": {
41
+ "description": "Set/limit the maximum concurrency for task execution.\n\nMust be an integer greater than or equal to `1` or a percentage value like `50%`. Use `1` to force serial execution (one task at a time). Use `100%` to use all available logical processors.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#concurrency",
42
+ "anyOf": [
43
+ {
44
+ "$ref": "#/definitions/String"
45
+ },
46
+ {
47
+ "type": "null"
48
+ }
49
+ ]
50
+ },
51
+ "daemon": {
52
+ "description": "Deprecated: The daemon is no longer used for `turbo run` and this option will be removed in version 3.0.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#daemon",
53
+ "anyOf": [
54
+ {
55
+ "$ref": "#/definitions/Boolean"
56
+ },
57
+ {
58
+ "type": "null"
59
+ }
60
+ ]
61
+ },
62
+ "dangerouslyDisablePackageManagerCheck": {
63
+ "description": "Disable check for `packageManager` in root `package.json`.\n\nThis is highly discouraged as it leaves `turbo` dependent on system configuration to infer the correct package manager. Some turbo features are disabled if this is set to true.",
64
+ "anyOf": [
65
+ {
66
+ "$ref": "#/definitions/Boolean"
67
+ },
68
+ {
69
+ "type": "null"
70
+ }
71
+ ]
72
+ },
73
+ "envMode": {
74
+ "description": "Turborepo's Environment Modes allow you to control which environment variables are available to a task at runtime.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#envmode",
75
+ "anyOf": [
76
+ {
77
+ "$ref": "#/definitions/EnvMode"
78
+ },
79
+ {
80
+ "type": "null"
81
+ }
82
+ ]
83
+ },
84
+ "extends": {
85
+ "description": "This key is only available in Workspace Configs and cannot be used in your root turbo.json.\n\nTells turbo to extend your root `turbo.json` and overrides with the keys provided in your Workspace Configs. Currently, only the `[\"//\"]` value is allowed.",
86
+ "anyOf": [
87
+ {
88
+ "$ref": "#/definitions/Array_of_String"
89
+ },
90
+ {
91
+ "type": "null"
92
+ }
93
+ ]
94
+ },
95
+ "futureFlags": {
96
+ "description": "Opt into breaking changes prior to major releases, experimental features, and beta features.",
97
+ "anyOf": [
98
+ {
99
+ "$ref": "#/definitions/FutureFlags"
100
+ },
101
+ {
102
+ "type": "null"
103
+ }
104
+ ]
105
+ },
106
+ "globalDependencies": {
107
+ "description": "A list of globs to include in the set of implicit global hash dependencies.\n\nThe contents of these files will be included in the global hashing algorithm and affect the hashes of all tasks.\n\nThis is useful for busting the cache based on: - `.env` files (not in Git) - Any root level file that impacts package tasks that are not represented in the traditional dependency graph (e.g. a root `tsconfig.json`, `jest.config.ts`, `.eslintrc`, etc.)\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globaldependencies",
108
+ "type": ["array", "null"],
109
+ "items": {
110
+ "$ref": "#/definitions/String"
111
+ }
112
+ },
113
+ "globalEnv": {
114
+ "description": "A list of environment variables for implicit global hash dependencies.\n\nThe variables included in this list will affect all task hashes.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globalenv",
115
+ "type": ["array", "null"],
116
+ "items": {
117
+ "$ref": "#/definitions/String"
118
+ }
119
+ },
120
+ "globalPassThroughEnv": {
121
+ "description": "An allowlist of environment variables that should be made to all tasks, but should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globalpassthroughenv",
122
+ "type": ["array", "null"],
123
+ "items": {
124
+ "$ref": "#/definitions/String"
125
+ }
126
+ },
127
+ "noUpdateNotifier": {
128
+ "description": "When set to `true`, disables the update notification that appears when a new version of `turbo` is available.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#noupdatenotifier",
129
+ "anyOf": [
130
+ {
131
+ "$ref": "#/definitions/Boolean"
132
+ },
133
+ {
134
+ "type": "null"
135
+ }
136
+ ]
137
+ },
138
+ "remoteCache": {
139
+ "description": "Configuration options when interfacing with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
6
140
  "anyOf": [
7
141
  {
8
- "$ref": "#/definitions/RootSchema"
142
+ "$ref": "#/definitions/RemoteCache"
9
143
  },
10
144
  {
11
- "$ref": "#/definitions/WorkspaceSchema"
145
+ "type": "null"
12
146
  }
13
147
  ]
14
148
  },
15
- "RootSchema": {
149
+ "tags": {
150
+ "description": "Used to tag a package for boundaries rules.\n\nBoundaries rules can restrict which packages a tag group can import or be imported by.",
151
+ "anyOf": [
152
+ {
153
+ "$ref": "#/definitions/Array_of_String"
154
+ },
155
+ {
156
+ "type": "null"
157
+ }
158
+ ]
159
+ },
160
+ "tasks": {
161
+ "description": "An object representing the task dependency graph of your project.\n\nturbo interprets these conventions to schedule, execute, and cache the outputs of tasks in your project.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#tasks",
162
+ "type": ["object", "null"],
163
+ "additionalProperties": {
164
+ "$ref": "#/definitions/Pipeline"
165
+ }
166
+ },
167
+ "ui": {
168
+ "description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
169
+ "anyOf": [
170
+ {
171
+ "$ref": "#/definitions/UI"
172
+ },
173
+ {
174
+ "type": "null"
175
+ }
176
+ ]
177
+ }
178
+ },
179
+ "allowComments": true,
180
+ "allowTrailingCommas": true,
181
+ "definitions": {
182
+ "Array_of_String": {
183
+ "type": "array",
184
+ "items": {
185
+ "$ref": "#/definitions/String"
186
+ }
187
+ },
188
+ "Boolean": {
189
+ "type": "boolean"
190
+ },
191
+ "BoundariesConfig": {
192
+ "description": "Configuration for `turbo boundaries`.\n\nAllows users to restrict a package's dependencies and dependents.",
16
193
  "type": "object",
17
194
  "properties": {
18
- "$schema": {
19
- "type": "string",
20
- "default": "https://turborepo.dev/schema.v2.json"
21
- },
22
- "tasks": {
23
- "type": "object",
24
- "additionalProperties": {
25
- "$ref": "#/definitions/Pipeline",
26
- "description": "The name of a task that can be executed by turbo. If turbo finds a workspace package with a package.json scripts object with a matching key, it will apply the pipeline task configuration to that npm script during execution."
27
- },
28
- "description": "An object representing the task dependency graph of your project. turbo interprets these conventions to schedule, execute, and cache the outputs of tasks in your project.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#tasks",
29
- "default": {}
30
- },
31
- "globalDependencies": {
32
- "type": "array",
33
- "items": {
34
- "type": "string"
35
- },
36
- "description": "A list of globs to include in the set of implicit global hash dependencies.\n\nThe contents of these files will be included in the global hashing algorithm and affect the hashes of all tasks.\n\nThis is useful for busting the cache based on:\n\n- .env files (not in Git)\n\n- any root level file that impacts package tasks that are not represented in the traditional dependency graph (e.g. a root tsconfig.json, jest.config.ts, .eslintrc, etc.)\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globaldependencies",
37
- "default": []
195
+ "dependencies": {
196
+ "description": "Rules for a package's dependencies.\n\nRestricts which packages this package can import.",
197
+ "anyOf": [
198
+ {
199
+ "$ref": "#/definitions/Permissions"
200
+ },
201
+ {
202
+ "type": "null"
203
+ }
204
+ ]
38
205
  },
39
- "globalEnv": {
40
- "type": "array",
41
- "items": {
42
- "$ref": "#/definitions/EnvWildcard"
43
- },
44
- "description": "A list of environment variables for implicit global hash dependencies.\n\nThe variables included in this list will affect all task hashes.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globalenv",
45
- "default": []
206
+ "dependents": {
207
+ "description": "Rules for a package's dependents.\n\nRestricts which packages can import this package.",
208
+ "anyOf": [
209
+ {
210
+ "$ref": "#/definitions/Permissions"
211
+ },
212
+ {
213
+ "type": "null"
214
+ }
215
+ ]
46
216
  },
47
- "globalPassThroughEnv": {
217
+ "implicitDependencies": {
218
+ "description": "Declares any implicit dependencies, i.e. any dependency not declared in a `package.json`.\n\nThese can include dependencies automatically injected by a framework or a testing library.",
48
219
  "anyOf": [
220
+ {
221
+ "$ref": "#/definitions/Array_of_String"
222
+ },
49
223
  {
50
224
  "type": "null"
225
+ }
226
+ ]
227
+ },
228
+ "tags": {
229
+ "description": "The boundaries rules for tags.\n\nRestricts which packages can import a tag and which packages a tag can import.",
230
+ "anyOf": [
231
+ {
232
+ "$ref": "#/definitions/Map_of_TagRules"
51
233
  },
52
234
  {
53
- "type": "array",
54
- "items": {
55
- "$ref": "#/definitions/EnvWildcard"
56
- }
235
+ "type": "null"
57
236
  }
58
- ],
59
- "description": "An allowlist of environment variables that should be made to all tasks, but should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#globalpassthroughenv",
60
- "default": null
237
+ ]
238
+ }
239
+ }
240
+ },
241
+ "EnvMode": {
242
+ "description": "Turborepo's Environment Modes allow you to control which environment variables are available to a task at runtime.\n\n- `strict`: Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`. - `loose`: Allow all environment variables for the process to be available.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#envmode",
243
+ "oneOf": [
244
+ {
245
+ "description": "Allow all environment variables for the process to be available.",
246
+ "type": "string",
247
+ "enum": ["loose"]
61
248
  },
62
- "remoteCache": {
63
- "$ref": "#/definitions/RemoteCache",
64
- "description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
65
- "default": {}
249
+ {
250
+ "description": "Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`.",
251
+ "type": "string",
252
+ "enum": ["strict"]
253
+ }
254
+ ]
255
+ },
256
+ "FutureFlags": {
257
+ "description": "Opt into breaking changes prior to major releases, experimental features, and beta features.\n\nNote: Currently all previous future flags (turboExtendsKeyword, nonRootExtends) have been graduated and are now enabled by default.",
258
+ "type": "object",
259
+ "properties": {
260
+ "affectedUsingTaskInputs": {
261
+ "description": "Use task-level `inputs` globs to determine which tasks are affected by changed files when running with `--affected`. When enabled, only tasks whose declared inputs match the changed files are selected, rather than selecting all tasks in changed packages.",
262
+ "default": false,
263
+ "type": "boolean"
66
264
  },
67
- "ui": {
68
- "$ref": "#/definitions/UI",
69
- "description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
70
- "default": "stream"
265
+ "errorsOnlyShowHash": {
266
+ "description": "When using `outputLogs: \"errors-only\"`, show task hashes when tasks complete successfully. This provides visibility into which tasks are running without showing full output logs.",
267
+ "default": false,
268
+ "type": "boolean"
71
269
  },
72
- "concurrency": {
73
- "type": "string",
74
- "description": "Set/limit the maximum concurrency for task execution. Must be an integer greater than or equal to `1` or a percentage value like `50%`.\n\n - Use `1` to force serial execution (one task at a time). - Use `100%` to use all available logical processors.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#concurrency",
75
- "default": "10"
76
- },
77
- "dangerouslyDisablePackageManagerCheck": {
78
- "type": "boolean",
79
- "description": "Disable check for `packageManager` in root `package.json`\n\nThis is highly discouraged as it leaves `turbo` dependent on system configuration to infer the correct package manager.\n\nSome turbo features are disabled if this is set to true.",
80
- "default": false
81
- },
82
- "cacheDir": {
83
- "$ref": "#/definitions/RelativeUnixPath",
84
- "description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cachedir",
85
- "default": ".turbo/cache"
86
- },
87
- "daemon": {
88
- "type": "boolean",
89
- "description": "Deprecated: The daemon is no longer used for `turbo run` and this option will be removed in version 3.0.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#daemon",
270
+ "experimentalObservability": {
271
+ "description": "Enable experimental OpenTelemetry exporter support.\n\nWhen enabled, Turborepo will honor the `experimentalObservability` configuration block (if present) to send run summaries to an observability backend.",
272
+ "default": false,
273
+ "type": "boolean"
274
+ },
275
+ "longerSignatureKey": {
276
+ "description": "Enforce a minimum length of 32 bytes for `TURBO_REMOTE_CACHE_SIGNATURE_KEY` when `remoteCache.signature` is enabled. Short keys weaken the HMAC-SHA256 signature, making brute-force tag collision feasible.",
277
+ "default": false,
278
+ "type": "boolean"
279
+ },
280
+ "watchUsingTaskInputs": {
281
+ "description": "Use task-level `inputs` globs to determine which tasks to re-run when files change in `turbo watch`. When enabled, only tasks whose declared inputs match the changed files are re-executed, rather than re-running all tasks in changed packages.",
90
282
  "default": false,
91
- "deprecated": true
92
- },
93
- "envMode": {
94
- "$ref": "#/definitions/EnvMode",
95
- "description": "Turborepo's Environment Modes allow you to control which environment variables are available to a task at runtime:\n\n- `\"strict\"`: Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`.\n- `\"loose\"`: Allow all environment variables for the process to be available.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#envmode",
96
- "default": "strict"
97
- },
98
- "boundaries": {
99
- "$ref": "#/definitions/RootBoundariesConfig",
100
- "description": "Configuration for `turbo boundaries`. Allows users to restrict a package's dependencies and dependents"
101
- },
102
- "noUpdateNotifier": {
103
- "type": "boolean",
104
- "description": "When set to `true`, disables the update notification that appears when a new version of `turbo` is available.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#noupdatenotifier",
105
- "default": false
106
- },
107
- "futureFlags": {
108
- "$ref": "#/definitions/FutureFlags",
109
- "description": "Opt into breaking changes prior to major releases, experimental features, and beta features.",
110
- "default": {}
283
+ "type": "boolean"
284
+ }
285
+ }
286
+ },
287
+ "Map_of_TagRules": {
288
+ "type": "object",
289
+ "additionalProperties": {
290
+ "$ref": "#/definitions/TagRules"
291
+ }
292
+ },
293
+ "OutputLogs": {
294
+ "description": "Output mode for the task.\n\n- `full`: Displays all output - `hash-only`: Show only the hashes of the tasks - `new-only`: Only show output from cache misses - `errors-only`: Only show output from task failures - `none`: Hides all task output\n\nDocumentation: https://turborepo.dev/docs/reference/run#--output-logs-option",
295
+ "oneOf": [
296
+ {
297
+ "description": "Displays all output.",
298
+ "type": "string",
299
+ "enum": ["full"]
300
+ },
301
+ {
302
+ "description": "Hides all task output.",
303
+ "type": "string",
304
+ "enum": ["none"]
305
+ },
306
+ {
307
+ "description": "Show only the hashes of the tasks.",
308
+ "type": "string",
309
+ "enum": ["hash-only"]
310
+ },
311
+ {
312
+ "description": "Only show output from cache misses.",
313
+ "type": "string",
314
+ "enum": ["new-only"]
315
+ },
316
+ {
317
+ "description": "Only show output from task failures.",
318
+ "type": "string",
319
+ "enum": ["errors-only"]
111
320
  }
112
- },
113
- "additionalProperties": false,
114
- "required": ["tasks"]
321
+ ]
322
+ },
323
+ "Permissions": {
324
+ "description": "Permission rules for boundaries.",
325
+ "type": "object",
326
+ "properties": {
327
+ "allow": {
328
+ "description": "Lists which tags are allowed.\n\nAny tag not included will be banned. If omitted, all tags are permitted.",
329
+ "anyOf": [
330
+ {
331
+ "$ref": "#/definitions/Array_of_String"
332
+ },
333
+ {
334
+ "type": "null"
335
+ }
336
+ ]
337
+ },
338
+ "deny": {
339
+ "description": "Lists which tags are banned.",
340
+ "anyOf": [
341
+ {
342
+ "$ref": "#/definitions/Array_of_String"
343
+ },
344
+ {
345
+ "type": "null"
346
+ }
347
+ ]
348
+ }
349
+ }
115
350
  },
116
351
  "Pipeline": {
352
+ "description": "Configuration for a pipeline task.\n\nThe name of a task that can be executed by turbo. If turbo finds a workspace package with a `package.json` scripts object with a matching key, it will apply the pipeline task configuration to that npm script during execution.",
117
353
  "type": "object",
118
354
  "properties": {
119
- "description": {
120
- "type": "string",
121
- "description": "A human-readable description of what this task does.\n\nThis field is for documentation purposes only and does not affect task execution or caching behavior."
355
+ "cache": {
356
+ "description": "Whether or not to cache the outputs of the task.\n\nSetting cache to false is useful for long-running \"watch\" or development mode tasks.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cache",
357
+ "anyOf": [
358
+ {
359
+ "$ref": "#/definitions/Boolean"
360
+ },
361
+ {
362
+ "type": "null"
363
+ }
364
+ ]
122
365
  },
123
366
  "dependsOn": {
124
- "type": "array",
125
- "items": {
126
- "type": "string"
127
- },
128
- "description": "The list of tasks that this task depends on.\n\nPrefixing an item in dependsOn with a ^ prefix tells turbo that this task depends on the package's topological dependencies completing the task first. (e.g. \"A package's build tasks should only run once all of its workspace dependencies have completed their own build commands.\")\n\nItems in dependsOn without a ^ prefix express the relationships between tasks within the same package (e.g. \"A package's test and lint commands depend on its own build being completed first.\")\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#dependson",
129
- "default": []
367
+ "description": "The list of tasks that this task depends on.\n\nPrefixing an item in `dependsOn` with a `^` prefix tells turbo that this task depends on the package's topological dependencies completing the task first. Items without a `^` prefix express the relationships between tasks within the same package.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#dependson",
368
+ "anyOf": [
369
+ {
370
+ "$ref": "#/definitions/Array_of_String"
371
+ },
372
+ {
373
+ "type": "null"
374
+ }
375
+ ]
376
+ },
377
+ "description": {
378
+ "description": "A human-readable description of what this task does.\n\nThis field is for documentation purposes only and does not affect task execution or caching behavior.",
379
+ "anyOf": [
380
+ {
381
+ "$ref": "#/definitions/String"
382
+ },
383
+ {
384
+ "type": "null"
385
+ }
386
+ ]
130
387
  },
131
388
  "env": {
132
- "type": "array",
389
+ "description": "A list of environment variables that this task depends on.\n\nNote: If you are migrating from a turbo version 1.5 or below, you may be used to prefixing your variables with a `$`. You no longer need to use the `$` prefix.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#env",
390
+ "type": ["array", "null"],
133
391
  "items": {
134
- "$ref": "#/definitions/EnvWildcard"
135
- },
136
- "description": "A list of environment variables that this task depends on.\n\nNote: If you are migrating from a turbo version 1.5 or below, you may be used to prefixing your variables with a $. You no longer need to use the $ prefix. (e.g. $GITHUB_TOKEN → GITHUB_TOKEN)\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#env",
137
- "default": []
392
+ "$ref": "#/definitions/String"
393
+ }
138
394
  },
139
- "passThroughEnv": {
395
+ "inputs": {
396
+ "description": "The set of glob patterns to consider as inputs to this task.\n\nChanges to files covered by these globs will cause a cache miss and the task will be rerun. If a file has been changed that is **not** included in the set of globs, it will not cause a cache miss. If omitted or empty, all files in the package are considered as inputs.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#inputs",
397
+ "type": ["array", "null"],
398
+ "items": {
399
+ "$ref": "#/definitions/String"
400
+ }
401
+ },
402
+ "interactive": {
403
+ "description": "Mark a task as interactive allowing it to receive input from stdin.\n\nInteractive tasks must be marked with `\"cache\": false` as the input they receive from stdin can change the outcome of the task.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#interactive",
140
404
  "anyOf": [
405
+ {
406
+ "$ref": "#/definitions/Boolean"
407
+ },
141
408
  {
142
409
  "type": "null"
410
+ }
411
+ ]
412
+ },
413
+ "interruptible": {
414
+ "description": "Label a persistent task as interruptible to allow it to be restarted by `turbo watch`.\n\n`turbo watch` watches for changes to your packages and automatically restarts tasks that are affected. However, if a task is persistent, it will not be restarted by default. To enable restarting persistent tasks, set `interruptible` to `true`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#interruptible",
415
+ "anyOf": [
416
+ {
417
+ "$ref": "#/definitions/Boolean"
143
418
  },
144
419
  {
145
- "type": "array",
146
- "items": {
147
- "$ref": "#/definitions/EnvWildcard"
148
- }
420
+ "type": "null"
149
421
  }
150
- ],
151
- "description": "An allowlist of environment variables that should be made available in this task's environment, but should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#passthroughenv",
152
- "default": null
422
+ ]
423
+ },
424
+ "outputLogs": {
425
+ "description": "Output mode for the task.\n\nDocumentation: https://turborepo.dev/docs/reference/run#--output-logs-option",
426
+ "anyOf": [
427
+ {
428
+ "$ref": "#/definitions/OutputLogs"
429
+ },
430
+ {
431
+ "type": "null"
432
+ }
433
+ ]
153
434
  },
154
435
  "outputs": {
155
- "type": "array",
156
- "items": {
157
- "type": "string"
158
- },
159
436
  "description": "The set of glob patterns indicating a task's cacheable filesystem outputs.\n\nTurborepo captures task logs for all tasks. This enables us to cache tasks whose runs produce no artifacts other than logs (such as linters). Logs are always treated as a cacheable artifact and never need to be specified.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#outputs",
160
- "default": []
161
- },
162
- "cache": {
163
- "type": "boolean",
164
- "description": "Whether or not to cache the outputs of the task.\n\nSetting cache to false is useful for long-running \"watch\" or development mode tasks.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cache",
165
- "default": true
166
- },
167
- "inputs": {
168
- "type": "array",
437
+ "type": ["array", "null"],
169
438
  "items": {
170
- "type": "string"
171
- },
172
- "description": "The set of glob patterns to consider as inputs to this task.\n\nChanges to files covered by these globs will cause a cache miss and the task will be rerun.\n\nIf a file has been changed that is **not** included in the set of globs, it will not cause a cache miss.\n\nIf omitted or empty, all files in the package are considered as inputs.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#inputs",
173
- "default": []
439
+ "$ref": "#/definitions/String"
440
+ }
174
441
  },
175
- "outputLogs": {
176
- "$ref": "#/definitions/OutputLogs",
177
- "description": "Output mode for the task.\n\n\"full\": Displays all output\n\n\"hash-only\": Show only the hashes of the tasks\n\n\"new-only\": Only show output from cache misses\n\n\"errors-only\": Only show output from task failures\n\n\"none\": Hides all task output\n\nDocumentation: https://turborepo.dev/docs/reference/run#--output-logs-option",
178
- "default": "full"
442
+ "passThroughEnv": {
443
+ "description": "An allowlist of environment variables that should be made available in this task's environment, but should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#passthroughenv",
444
+ "type": ["array", "null"],
445
+ "items": {
446
+ "$ref": "#/definitions/String"
447
+ }
179
448
  },
180
449
  "persistent": {
181
- "type": "boolean",
182
- "description": "Indicates whether the task exits or not. Setting `persistent` to `true` tells turbo that this is a long-running task and will ensure that other tasks cannot depend on it.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#persistent",
183
- "default": false
184
- },
185
- "interactive": {
186
- "type": "boolean",
187
- "description": "Mark a task as interactive allowing it to receive input from stdin. Interactive tasks must be marked with \"cache\": false as the input they receive from stdin can change the outcome of the task.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#interactive",
188
- "default": false
189
- },
190
- "interruptible": {
191
- "type": "boolean",
192
- "description": "Label a persistent task as interruptible to allow it to be restarted by `turbo watch`. `turbo watch` watches for changes to your packages and automatically restarts tasks that are affected. However, if a task is persistent, it will not be restarted by default. To enable restarting persistent tasks, set `interruptible` to true.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#interruptible",
193
- "default": false
450
+ "description": "Indicates whether the task exits or not.\n\nSetting `persistent` to `true` tells turbo that this is a long-running task and will ensure that other tasks cannot depend on it.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#persistent",
451
+ "anyOf": [
452
+ {
453
+ "$ref": "#/definitions/Boolean"
454
+ },
455
+ {
456
+ "type": "null"
457
+ }
458
+ ]
194
459
  },
195
460
  "with": {
196
- "type": "array",
197
- "items": {
198
- "type": "string"
199
- },
200
461
  "description": "A list of tasks that will run alongside this task.\n\nTasks in this list will not be run until completion before this task starts execution.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#with",
201
- "default": []
462
+ "type": ["array", "null"],
463
+ "items": {
464
+ "$ref": "#/definitions/String"
465
+ }
202
466
  }
203
- },
204
- "additionalProperties": false
205
- },
206
- "EnvWildcard": {
207
- "type": "string"
208
- },
209
- "OutputLogs": {
210
- "type": "string",
211
- "enum": ["full", "none", "hash-only", "new-only", "errors-only"]
467
+ }
212
468
  },
213
469
  "RemoteCache": {
470
+ "description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
214
471
  "type": "object",
215
472
  "properties": {
216
- "signature": {
217
- "type": "boolean",
218
- "description": "Indicates if signature verification is enabled for requests to the remote cache. When `true`, Turborepo will sign every uploaded artifact using the value of the environment variable `TURBO_REMOTE_CACHE_SIGNATURE_KEY`. Turborepo will reject any downloaded artifacts that have an invalid signature or are missing a signature.",
219
- "default": false
473
+ "apiUrl": {
474
+ "description": "Set endpoint for API calls to the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
475
+ "anyOf": [
476
+ {
477
+ "$ref": "#/definitions/String"
478
+ },
479
+ {
480
+ "type": "null"
481
+ }
482
+ ]
220
483
  },
221
484
  "enabled": {
222
- "type": "boolean",
223
- "description": "Indicates if the remote cache is enabled. When `false`, Turborepo will disable all remote cache operations, even if the repo has a valid token. If true, remote caching is enabled, but still requires the user to login and link their repo to a remote cache. Documentation: https://turborepo.dev/docs/core-concepts/remote-caching",
224
- "default": true
225
- },
226
- "preflight": {
227
- "type": "boolean",
228
- "description": "When enabled, any HTTP request will be preceded by an OPTIONS request to determine if the request is supported by the endpoint.\n\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#preflighted_requests",
229
- "default": false
230
- },
231
- "apiUrl": {
232
- "type": "string",
233
- "description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
234
- "default": "https://vercel.com/api"
485
+ "description": "Indicates if the remote cache is enabled.\n\nWhen `false`, Turborepo will disable all remote cache operations, even if the repo has a valid token. If `true`, remote caching is enabled, but still requires the user to login and link their repo to a remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
486
+ "anyOf": [
487
+ {
488
+ "$ref": "#/definitions/Boolean"
489
+ },
490
+ {
491
+ "type": "null"
492
+ }
493
+ ]
235
494
  },
236
495
  "loginUrl": {
237
- "type": "string",
238
- "description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
239
- "default": "https://vercel.com"
496
+ "description": "Set endpoint for requesting tokens during `turbo login`.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
497
+ "anyOf": [
498
+ {
499
+ "$ref": "#/definitions/String"
500
+ },
501
+ {
502
+ "type": "null"
503
+ }
504
+ ]
240
505
  },
241
- "timeout": {
242
- "type": "number",
243
- "description": "Sets a timeout for remote cache operations. Value is given in seconds and only whole values are accepted. If `0` is passed, then there is no timeout for any cache operations.",
244
- "default": 30
506
+ "preflight": {
507
+ "description": "When enabled, any HTTP request will be preceded by an OPTIONS request to determine if the request is supported by the endpoint.\n\nDocumentation: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#preflighted_requests",
508
+ "anyOf": [
509
+ {
510
+ "$ref": "#/definitions/Boolean"
511
+ },
512
+ {
513
+ "type": "null"
514
+ }
515
+ ]
245
516
  },
246
- "uploadTimeout": {
247
- "type": "number",
248
- "description": "Sets a timeout for remote cache uploads. Value is given in seconds and only whole values are accepted. If `0` is passed, then there is no timeout for any remote cache uploads.",
249
- "default": 60
517
+ "signature": {
518
+ "description": "Indicates if signature verification is enabled for requests to the remote cache.\n\nWhen `true`, Turborepo will sign every uploaded artifact using the value of the environment variable `TURBO_REMOTE_CACHE_SIGNATURE_KEY`. Turborepo will reject any downloaded artifacts that have an invalid signature or are missing a signature.",
519
+ "anyOf": [
520
+ {
521
+ "$ref": "#/definitions/Boolean"
522
+ },
523
+ {
524
+ "type": "null"
525
+ }
526
+ ]
250
527
  },
251
528
  "teamId": {
252
- "type": "string",
253
- "description": "The ID of the Remote Cache team. Value will be passed as `teamId` in the querystring for all Remote Cache HTTP calls. Must start with `team_` or it will not be used."
529
+ "description": "The ID of the Remote Cache team.\n\nValue will be passed as `teamId` in the querystring for all Remote Cache HTTP calls. Must start with `team_` or it will not be used.",
530
+ "anyOf": [
531
+ {
532
+ "$ref": "#/definitions/String"
533
+ },
534
+ {
535
+ "type": "null"
536
+ }
537
+ ]
254
538
  },
255
539
  "teamSlug": {
256
- "type": "string",
257
- "description": "The slug of the Remote Cache team. Value will be passed as `slug` in the querystring for all Remote Cache HTTP calls."
258
- }
259
- },
260
- "additionalProperties": false
261
- },
262
- "UI": {
263
- "type": "string",
264
- "enum": ["tui", "stream"]
265
- },
266
- "RelativeUnixPath": {
267
- "type": "string",
268
- "description": "This is a relative Unix-style path (e.g. `./src/index.ts` or `src/index.ts`). Absolute paths (e.g. `/tmp/foo`) are not valid."
269
- },
270
- "EnvMode": {
271
- "type": "string",
272
- "enum": ["loose", "strict"]
273
- },
274
- "RootBoundariesConfig": {
275
- "type": "object",
276
- "properties": {
277
- "implicitDependencies": {
278
- "type": "array",
279
- "items": {
280
- "type": "string"
281
- },
282
- "description": "Declares any implicit dependencies, i.e. any dependency not declared in a package.json. These can include dependencies automatically injected by a framework or a testing library."
540
+ "description": "The slug of the Remote Cache team.\n\nValue will be passed as `slug` in the querystring for all Remote Cache HTTP calls.",
541
+ "anyOf": [
542
+ {
543
+ "$ref": "#/definitions/String"
544
+ },
545
+ {
546
+ "type": "null"
547
+ }
548
+ ]
283
549
  },
284
- "tags": {
285
- "$ref": "#/definitions/BoundariesRulesMap",
286
- "description": "The boundaries rules for tags. Restricts which packages can import a tag and which packages a tag can import"
287
- }
288
- },
289
- "additionalProperties": false
290
- },
291
- "BoundariesRulesMap": {
292
- "type": "object",
293
- "additionalProperties": {
294
- "type": "object",
295
- "properties": {
296
- "dependencies": {
297
- "$ref": "#/definitions/Permissions",
298
- "description": "Rules for a tag's dependencies. Restricts which packages a tag can import"
299
- },
300
- "dependents": {
301
- "$ref": "#/definitions/Permissions",
302
- "description": "Rules for a tag's dependents. Restricts which packages can import this tag."
303
- }
550
+ "timeout": {
551
+ "description": "Sets a timeout for remote cache operations.\n\nValue is given in seconds and only whole values are accepted. If `0` is passed, then there is no timeout for any cache operations.",
552
+ "anyOf": [
553
+ {
554
+ "$ref": "#/definitions/uint64"
555
+ },
556
+ {
557
+ "type": "null"
558
+ }
559
+ ]
304
560
  },
305
- "additionalProperties": false
561
+ "uploadTimeout": {
562
+ "description": "Sets a timeout for remote cache uploads.\n\nValue is given in seconds and only whole values are accepted. If `0` is passed, then there is no timeout for any remote cache uploads.",
563
+ "anyOf": [
564
+ {
565
+ "$ref": "#/definitions/uint64"
566
+ },
567
+ {
568
+ "type": "null"
569
+ }
570
+ ]
571
+ }
306
572
  }
307
573
  },
308
- "Permissions": {
309
- "type": "object",
310
- "properties": {
311
- "allow": {
312
- "type": "array",
313
- "items": {
314
- "type": "string"
315
- },
316
- "description": "Lists which tags are allowed. Any tag not included will be banned If omitted, all tags are permitted"
317
- },
318
- "deny": {
319
- "type": "array",
320
- "items": {
321
- "type": "string"
322
- },
323
- "description": "Lists which tags are banned."
324
- }
325
- },
326
- "additionalProperties": false
574
+ "String": {
575
+ "type": "string"
327
576
  },
328
- "FutureFlags": {
577
+ "TagRules": {
578
+ "description": "Boundary rules for a tag.\n\nRestricts which packages a tag can import and which packages can import this tag.",
329
579
  "type": "object",
330
580
  "properties": {
331
- "errorsOnlyShowHash": {
332
- "type": "boolean",
333
- "description": "When using `outputLogs: \"errors-only\"`, show task hashes when tasks complete successfully. This provides visibility into which tasks are running without showing full output logs.",
334
- "default": false
581
+ "dependencies": {
582
+ "description": "Rules for a tag's dependencies.\n\nRestricts which packages a tag can import.",
583
+ "anyOf": [
584
+ {
585
+ "$ref": "#/definitions/Permissions"
586
+ },
587
+ {
588
+ "type": "null"
589
+ }
590
+ ]
335
591
  },
336
- "longerSignatureKey": {
337
- "type": "boolean",
338
- "description": "Enforce a minimum length of 32 bytes for `TURBO_REMOTE_CACHE_SIGNATURE_KEY` when `remoteCache.signature` is enabled. Short keys weaken the HMAC-SHA256 signature, making brute-force tag collision feasible.",
339
- "default": false
592
+ "dependents": {
593
+ "description": "Rules for a tag's dependents.\n\nRestricts which packages can import this tag.",
594
+ "anyOf": [
595
+ {
596
+ "$ref": "#/definitions/Permissions"
597
+ },
598
+ {
599
+ "type": "null"
600
+ }
601
+ ]
340
602
  }
341
- },
342
- "additionalProperties": false
603
+ }
343
604
  },
344
- "WorkspaceSchema": {
345
- "type": "object",
346
- "properties": {
347
- "$schema": {
605
+ "UI": {
606
+ "description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
607
+ "oneOf": [
608
+ {
609
+ "description": "Use the terminal user interface.",
348
610
  "type": "string",
349
- "default": "https://turborepo.dev/schema.v2.json"
350
- },
351
- "tasks": {
352
- "type": "object",
353
- "additionalProperties": {
354
- "$ref": "#/definitions/Pipeline",
355
- "description": "The name of a task that can be executed by turbo. If turbo finds a workspace package with a package.json scripts object with a matching key, it will apply the pipeline task configuration to that npm script during execution."
356
- },
357
- "description": "An object representing the task dependency graph of your project. turbo interprets these conventions to schedule, execute, and cache the outputs of tasks in your project.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#tasks",
358
- "default": {}
359
- },
360
- "extends": {
361
- "type": "array",
362
- "items": {
363
- "type": "string"
364
- },
365
- "description": "This key is only available in Workspace Configs and cannot be used in your root turbo.json.\n\nTells turbo to extend your root `turbo.json` and overrides with the keys provided in your Workspace Configs.\n\nCurrently, only the \"//\" value is allowed.",
366
- "default": ["//"]
611
+ "enum": ["tui"]
367
612
  },
368
- "tags": {
369
- "type": "array",
370
- "items": {
371
- "type": "string"
372
- },
373
- "description": "Used to tag a package for boundaries rules. Boundaries rules can restrict which packages a tag group can import or be imported by."
613
+ {
614
+ "description": "Use the standard output stream.",
615
+ "type": "string",
616
+ "enum": ["stream"]
374
617
  },
375
- "boundaries": {
376
- "$ref": "#/definitions/BoundariesConfig",
377
- "description": "Configuration for `turbo boundaries` that is specific to this package"
618
+ {
619
+ "description": "Use the standard output stream with timestamps. Note: This feature is experimental and may change or be removed at any time.",
620
+ "type": "string",
621
+ "enum": ["stream-with-experimental-timestamps"]
378
622
  }
379
- },
380
- "required": ["extends", "tasks"],
381
- "additionalProperties": false,
382
- "description": "A `turbo.json` file in a package in the monorepo (not the root)"
623
+ ]
383
624
  },
384
- "BoundariesConfig": {
385
- "type": "object",
386
- "properties": {
387
- "implicitDependencies": {
388
- "type": "array",
389
- "items": {
390
- "type": "string"
391
- },
392
- "description": "Declares any implicit dependencies, i.e. any dependency not declared in a package.json. These can include dependencies automatically injected by a framework or a testing library."
393
- }
394
- },
395
- "additionalProperties": false
625
+ "uint64": {
626
+ "type": "integer",
627
+ "format": "uint64",
628
+ "minimum": 0.0
396
629
  }
397
630
  }
398
631
  }
@@ -226,6 +226,15 @@ export interface FutureFlags {
226
226
  * @defaultValue `false`
227
227
  */
228
228
  longerSignatureKey?: boolean;
229
+ /**
230
+ * Use task-level `inputs` globs to determine which tasks are affected by
231
+ * changed files when running with `--affected`. When enabled, only tasks
232
+ * whose declared inputs match the changed files are selected, rather than
233
+ * selecting all tasks in changed packages.
234
+ *
235
+ * @defaultValue `false`
236
+ */
237
+ affectedUsingTaskInputs?: boolean;
229
238
  }
230
239
 
231
240
  export interface Pipeline {