@turbo/types 2.7.5-canary.1 → 2.7.5-canary.11
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/LICENSE +1 -1
- package/README.md +1 -1
- package/package.json +2 -2
- package/schemas/schema.json +41 -30
- package/schemas/schema.v1.json +19 -19
- package/schemas/schema.v2.json +32 -28
- package/src/types/config-v1.ts +17 -17
- package/src/types/config-v2.ts +34 -26
package/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Copyright (c)
|
|
1
|
+
Copyright (c) 2026 Vercel, Inc
|
|
2
2
|
|
|
3
3
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
4
|
|
package/README.md
CHANGED
|
@@ -4,4 +4,4 @@ TypeScript types for `turbo.json`
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
For more information about Turborepo, visit [turborepo.
|
|
7
|
+
For more information about Turborepo, visit [turborepo.dev](https://turborepo.dev) and follow us on X ([@turborepo](https://x.com/turborepo))!
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turbo/types",
|
|
3
|
-
"version": "2.7.5-canary.
|
|
3
|
+
"version": "2.7.5-canary.11",
|
|
4
4
|
"description": "Turborepo types",
|
|
5
5
|
"type": "commonjs",
|
|
6
|
-
"homepage": "https://turborepo.
|
|
6
|
+
"homepage": "https://turborepo.dev",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
package/schemas/schema.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
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.
|
|
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
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"$schema": {
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
]
|
|
28
28
|
},
|
|
29
29
|
"cacheDir": {
|
|
30
|
-
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.
|
|
30
|
+
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cachedir",
|
|
31
31
|
"anyOf": [
|
|
32
32
|
{
|
|
33
33
|
"$ref": "#/definitions/String"
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
]
|
|
39
39
|
},
|
|
40
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.
|
|
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
42
|
"anyOf": [
|
|
43
43
|
{
|
|
44
44
|
"$ref": "#/definitions/String"
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
]
|
|
50
50
|
},
|
|
51
51
|
"daemon": {
|
|
52
|
-
"description": "Turborepo runs a background process to pre-calculate some expensive operations. This standalone process (daemon) is a performance optimization, and not required for proper functioning of `turbo`.\n\nDocumentation: https://turborepo.
|
|
52
|
+
"description": "Turborepo runs a background process to pre-calculate some expensive operations. This standalone process (daemon) is a performance optimization, and not required for proper functioning of `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#daemon",
|
|
53
53
|
"anyOf": [
|
|
54
54
|
{
|
|
55
55
|
"$ref": "#/definitions/Boolean"
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
]
|
|
72
72
|
},
|
|
73
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.
|
|
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
75
|
"anyOf": [
|
|
76
76
|
{
|
|
77
77
|
"$ref": "#/definitions/EnvMode"
|
|
@@ -104,28 +104,28 @@
|
|
|
104
104
|
]
|
|
105
105
|
},
|
|
106
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.
|
|
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
108
|
"type": ["array", "null"],
|
|
109
109
|
"items": {
|
|
110
110
|
"$ref": "#/definitions/String"
|
|
111
111
|
}
|
|
112
112
|
},
|
|
113
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.
|
|
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
115
|
"type": ["array", "null"],
|
|
116
116
|
"items": {
|
|
117
117
|
"$ref": "#/definitions/String"
|
|
118
118
|
}
|
|
119
119
|
},
|
|
120
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.
|
|
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
122
|
"type": ["array", "null"],
|
|
123
123
|
"items": {
|
|
124
124
|
"$ref": "#/definitions/String"
|
|
125
125
|
}
|
|
126
126
|
},
|
|
127
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.
|
|
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
129
|
"anyOf": [
|
|
130
130
|
{
|
|
131
131
|
"$ref": "#/definitions/Boolean"
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
]
|
|
137
137
|
},
|
|
138
138
|
"remoteCache": {
|
|
139
|
-
"description": "Configuration options when interfacing with the remote cache.\n\nDocumentation: https://turborepo.
|
|
139
|
+
"description": "Configuration options when interfacing with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
|
|
140
140
|
"anyOf": [
|
|
141
141
|
{
|
|
142
142
|
"$ref": "#/definitions/RemoteCache"
|
|
@@ -158,14 +158,14 @@
|
|
|
158
158
|
]
|
|
159
159
|
},
|
|
160
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.
|
|
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
162
|
"type": ["object", "null"],
|
|
163
163
|
"additionalProperties": {
|
|
164
164
|
"$ref": "#/definitions/Pipeline"
|
|
165
165
|
}
|
|
166
166
|
},
|
|
167
167
|
"ui": {
|
|
168
|
-
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.
|
|
168
|
+
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
|
|
169
169
|
"anyOf": [
|
|
170
170
|
{
|
|
171
171
|
"$ref": "#/definitions/UI"
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
}
|
|
238
238
|
},
|
|
239
239
|
"EnvMode": {
|
|
240
|
-
"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.
|
|
240
|
+
"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",
|
|
241
241
|
"oneOf": [
|
|
242
242
|
{
|
|
243
243
|
"description": "Allow all environment variables for the process to be available.",
|
|
@@ -262,7 +262,7 @@
|
|
|
262
262
|
}
|
|
263
263
|
},
|
|
264
264
|
"OutputLogs": {
|
|
265
|
-
"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.
|
|
265
|
+
"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",
|
|
266
266
|
"oneOf": [
|
|
267
267
|
{
|
|
268
268
|
"description": "Displays all output.",
|
|
@@ -324,7 +324,7 @@
|
|
|
324
324
|
"type": "object",
|
|
325
325
|
"properties": {
|
|
326
326
|
"cache": {
|
|
327
|
-
"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.
|
|
327
|
+
"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",
|
|
328
328
|
"anyOf": [
|
|
329
329
|
{
|
|
330
330
|
"$ref": "#/definitions/Boolean"
|
|
@@ -335,7 +335,7 @@
|
|
|
335
335
|
]
|
|
336
336
|
},
|
|
337
337
|
"dependsOn": {
|
|
338
|
-
"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.
|
|
338
|
+
"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",
|
|
339
339
|
"anyOf": [
|
|
340
340
|
{
|
|
341
341
|
"$ref": "#/definitions/Array_of_String"
|
|
@@ -345,22 +345,33 @@
|
|
|
345
345
|
}
|
|
346
346
|
]
|
|
347
347
|
},
|
|
348
|
+
"description": {
|
|
349
|
+
"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.",
|
|
350
|
+
"anyOf": [
|
|
351
|
+
{
|
|
352
|
+
"$ref": "#/definitions/String"
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"type": "null"
|
|
356
|
+
}
|
|
357
|
+
]
|
|
358
|
+
},
|
|
348
359
|
"env": {
|
|
349
|
-
"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.
|
|
360
|
+
"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",
|
|
350
361
|
"type": ["array", "null"],
|
|
351
362
|
"items": {
|
|
352
363
|
"$ref": "#/definitions/String"
|
|
353
364
|
}
|
|
354
365
|
},
|
|
355
366
|
"inputs": {
|
|
356
|
-
"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.
|
|
367
|
+
"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",
|
|
357
368
|
"type": ["array", "null"],
|
|
358
369
|
"items": {
|
|
359
370
|
"$ref": "#/definitions/String"
|
|
360
371
|
}
|
|
361
372
|
},
|
|
362
373
|
"interactive": {
|
|
363
|
-
"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.
|
|
374
|
+
"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",
|
|
364
375
|
"anyOf": [
|
|
365
376
|
{
|
|
366
377
|
"$ref": "#/definitions/Boolean"
|
|
@@ -371,7 +382,7 @@
|
|
|
371
382
|
]
|
|
372
383
|
},
|
|
373
384
|
"interruptible": {
|
|
374
|
-
"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.
|
|
385
|
+
"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",
|
|
375
386
|
"anyOf": [
|
|
376
387
|
{
|
|
377
388
|
"$ref": "#/definitions/Boolean"
|
|
@@ -382,7 +393,7 @@
|
|
|
382
393
|
]
|
|
383
394
|
},
|
|
384
395
|
"outputLogs": {
|
|
385
|
-
"description": "Output mode for the task.\n\nDocumentation: https://turborepo.
|
|
396
|
+
"description": "Output mode for the task.\n\nDocumentation: https://turborepo.dev/docs/reference/run#--output-logs-option",
|
|
386
397
|
"anyOf": [
|
|
387
398
|
{
|
|
388
399
|
"$ref": "#/definitions/OutputLogs"
|
|
@@ -393,21 +404,21 @@
|
|
|
393
404
|
]
|
|
394
405
|
},
|
|
395
406
|
"outputs": {
|
|
396
|
-
"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.
|
|
407
|
+
"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",
|
|
397
408
|
"type": ["array", "null"],
|
|
398
409
|
"items": {
|
|
399
410
|
"$ref": "#/definitions/String"
|
|
400
411
|
}
|
|
401
412
|
},
|
|
402
413
|
"passThroughEnv": {
|
|
403
|
-
"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.
|
|
414
|
+
"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",
|
|
404
415
|
"type": ["array", "null"],
|
|
405
416
|
"items": {
|
|
406
417
|
"$ref": "#/definitions/String"
|
|
407
418
|
}
|
|
408
419
|
},
|
|
409
420
|
"persistent": {
|
|
410
|
-
"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.
|
|
421
|
+
"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",
|
|
411
422
|
"anyOf": [
|
|
412
423
|
{
|
|
413
424
|
"$ref": "#/definitions/Boolean"
|
|
@@ -418,7 +429,7 @@
|
|
|
418
429
|
]
|
|
419
430
|
},
|
|
420
431
|
"with": {
|
|
421
|
-
"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.
|
|
432
|
+
"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",
|
|
422
433
|
"type": ["array", "null"],
|
|
423
434
|
"items": {
|
|
424
435
|
"$ref": "#/definitions/String"
|
|
@@ -427,11 +438,11 @@
|
|
|
427
438
|
}
|
|
428
439
|
},
|
|
429
440
|
"RemoteCache": {
|
|
430
|
-
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.
|
|
441
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
|
|
431
442
|
"type": "object",
|
|
432
443
|
"properties": {
|
|
433
444
|
"apiUrl": {
|
|
434
|
-
"description": "Set endpoint for API calls to the remote cache.\n\nDocumentation: https://turborepo.
|
|
445
|
+
"description": "Set endpoint for API calls to the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
|
|
435
446
|
"anyOf": [
|
|
436
447
|
{
|
|
437
448
|
"$ref": "#/definitions/String"
|
|
@@ -442,7 +453,7 @@
|
|
|
442
453
|
]
|
|
443
454
|
},
|
|
444
455
|
"enabled": {
|
|
445
|
-
"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.
|
|
456
|
+
"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",
|
|
446
457
|
"anyOf": [
|
|
447
458
|
{
|
|
448
459
|
"$ref": "#/definitions/Boolean"
|
|
@@ -453,7 +464,7 @@
|
|
|
453
464
|
]
|
|
454
465
|
},
|
|
455
466
|
"loginUrl": {
|
|
456
|
-
"description": "Set endpoint for requesting tokens during `turbo login`.\n\nDocumentation: https://turborepo.
|
|
467
|
+
"description": "Set endpoint for requesting tokens during `turbo login`.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
|
|
457
468
|
"anyOf": [
|
|
458
469
|
{
|
|
459
470
|
"$ref": "#/definitions/String"
|
|
@@ -563,7 +574,7 @@
|
|
|
563
574
|
}
|
|
564
575
|
},
|
|
565
576
|
"UI": {
|
|
566
|
-
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.
|
|
577
|
+
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
|
|
567
578
|
"oneOf": [
|
|
568
579
|
{
|
|
569
580
|
"description": "Use the terminal user interface.",
|
package/schemas/schema.v1.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"properties": {
|
|
18
18
|
"$schema": {
|
|
19
19
|
"type": "string",
|
|
20
|
-
"default": "https://turborepo.
|
|
20
|
+
"default": "https://turborepo.dev/schema.v1.json"
|
|
21
21
|
},
|
|
22
22
|
"pipeline": {
|
|
23
23
|
"type": "object",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"$ref": "#/definitions/PipelineV1",
|
|
26
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
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.
|
|
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
29
|
"default": {}
|
|
30
30
|
},
|
|
31
31
|
"extends": {
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"items": {
|
|
49
49
|
"type": "string"
|
|
50
50
|
},
|
|
51
|
-
"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.
|
|
51
|
+
"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",
|
|
52
52
|
"default": []
|
|
53
53
|
},
|
|
54
54
|
"env": {
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"items": {
|
|
57
57
|
"$ref": "#/definitions/EnvWildcardV1"
|
|
58
58
|
},
|
|
59
|
-
"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.
|
|
59
|
+
"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",
|
|
60
60
|
"default": []
|
|
61
61
|
},
|
|
62
62
|
"passThroughEnv": {
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
}
|
|
72
72
|
}
|
|
73
73
|
],
|
|
74
|
-
"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.
|
|
74
|
+
"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",
|
|
75
75
|
"default": null
|
|
76
76
|
},
|
|
77
77
|
"dotEnv": {
|
|
@@ -94,12 +94,12 @@
|
|
|
94
94
|
"items": {
|
|
95
95
|
"type": "string"
|
|
96
96
|
},
|
|
97
|
-
"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.
|
|
97
|
+
"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",
|
|
98
98
|
"default": []
|
|
99
99
|
},
|
|
100
100
|
"cache": {
|
|
101
101
|
"type": "boolean",
|
|
102
|
-
"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.
|
|
102
|
+
"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",
|
|
103
103
|
"default": true
|
|
104
104
|
},
|
|
105
105
|
"inputs": {
|
|
@@ -107,22 +107,22 @@
|
|
|
107
107
|
"items": {
|
|
108
108
|
"type": "string"
|
|
109
109
|
},
|
|
110
|
-
"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.
|
|
110
|
+
"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",
|
|
111
111
|
"default": []
|
|
112
112
|
},
|
|
113
113
|
"outputMode": {
|
|
114
114
|
"$ref": "#/definitions/OutputModeV1",
|
|
115
|
-
"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.
|
|
115
|
+
"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",
|
|
116
116
|
"default": "full"
|
|
117
117
|
},
|
|
118
118
|
"persistent": {
|
|
119
119
|
"type": "boolean",
|
|
120
|
-
"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.
|
|
120
|
+
"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",
|
|
121
121
|
"default": false
|
|
122
122
|
},
|
|
123
123
|
"interactive": {
|
|
124
124
|
"type": "boolean",
|
|
125
|
-
"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.
|
|
125
|
+
"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",
|
|
126
126
|
"default": false
|
|
127
127
|
}
|
|
128
128
|
},
|
|
@@ -143,7 +143,7 @@
|
|
|
143
143
|
"properties": {
|
|
144
144
|
"$schema": {
|
|
145
145
|
"type": "string",
|
|
146
|
-
"default": "https://turborepo.
|
|
146
|
+
"default": "https://turborepo.dev/schema.v1.json"
|
|
147
147
|
},
|
|
148
148
|
"pipeline": {
|
|
149
149
|
"type": "object",
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
"$ref": "#/definitions/PipelineV1",
|
|
152
152
|
"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."
|
|
153
153
|
},
|
|
154
|
-
"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.
|
|
154
|
+
"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",
|
|
155
155
|
"default": {}
|
|
156
156
|
},
|
|
157
157
|
"globalDependencies": {
|
|
@@ -159,7 +159,7 @@
|
|
|
159
159
|
"items": {
|
|
160
160
|
"type": "string"
|
|
161
161
|
},
|
|
162
|
-
"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.
|
|
162
|
+
"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",
|
|
163
163
|
"default": []
|
|
164
164
|
},
|
|
165
165
|
"globalEnv": {
|
|
@@ -167,7 +167,7 @@
|
|
|
167
167
|
"items": {
|
|
168
168
|
"$ref": "#/definitions/EnvWildcardV1"
|
|
169
169
|
},
|
|
170
|
-
"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.
|
|
170
|
+
"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",
|
|
171
171
|
"default": []
|
|
172
172
|
},
|
|
173
173
|
"globalPassThroughEnv": {
|
|
@@ -182,7 +182,7 @@
|
|
|
182
182
|
}
|
|
183
183
|
}
|
|
184
184
|
],
|
|
185
|
-
"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.
|
|
185
|
+
"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",
|
|
186
186
|
"default": null
|
|
187
187
|
},
|
|
188
188
|
"globalDotEnv": {
|
|
@@ -202,12 +202,12 @@
|
|
|
202
202
|
},
|
|
203
203
|
"remoteCache": {
|
|
204
204
|
"$ref": "#/definitions/RemoteCacheV1",
|
|
205
|
-
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.
|
|
205
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
|
|
206
206
|
"default": {}
|
|
207
207
|
},
|
|
208
208
|
"experimentalUI": {
|
|
209
209
|
"type": "boolean",
|
|
210
|
-
"description": "Enable use of the new UI for `turbo`\n\nDocumentation: https://turborepo.
|
|
210
|
+
"description": "Enable use of the new UI for `turbo`\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
|
|
211
211
|
"default": false
|
|
212
212
|
}
|
|
213
213
|
},
|
|
@@ -224,7 +224,7 @@
|
|
|
224
224
|
},
|
|
225
225
|
"enabled": {
|
|
226
226
|
"type": "boolean",
|
|
227
|
-
"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.
|
|
227
|
+
"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",
|
|
228
228
|
"default": true
|
|
229
229
|
}
|
|
230
230
|
},
|
package/schemas/schema.v2.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"properties": {
|
|
18
18
|
"$schema": {
|
|
19
19
|
"type": "string",
|
|
20
|
-
"default": "https://turborepo.
|
|
20
|
+
"default": "https://turborepo.dev/schema.v2.json"
|
|
21
21
|
},
|
|
22
22
|
"tasks": {
|
|
23
23
|
"type": "object",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"$ref": "#/definitions/Pipeline",
|
|
26
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
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.
|
|
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
29
|
"default": {}
|
|
30
30
|
},
|
|
31
31
|
"globalDependencies": {
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"items": {
|
|
34
34
|
"type": "string"
|
|
35
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.
|
|
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
37
|
"default": []
|
|
38
38
|
},
|
|
39
39
|
"globalEnv": {
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
"items": {
|
|
42
42
|
"$ref": "#/definitions/EnvWildcard"
|
|
43
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.
|
|
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
45
|
"default": []
|
|
46
46
|
},
|
|
47
47
|
"globalPassThroughEnv": {
|
|
@@ -56,22 +56,22 @@
|
|
|
56
56
|
}
|
|
57
57
|
}
|
|
58
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.
|
|
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
60
|
"default": null
|
|
61
61
|
},
|
|
62
62
|
"remoteCache": {
|
|
63
63
|
"$ref": "#/definitions/RemoteCache",
|
|
64
|
-
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.
|
|
64
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.dev/docs/core-concepts/remote-caching",
|
|
65
65
|
"default": {}
|
|
66
66
|
},
|
|
67
67
|
"ui": {
|
|
68
68
|
"$ref": "#/definitions/UI",
|
|
69
|
-
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.
|
|
69
|
+
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#ui",
|
|
70
70
|
"default": "stream"
|
|
71
71
|
},
|
|
72
72
|
"concurrency": {
|
|
73
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.
|
|
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
75
|
"default": "10"
|
|
76
76
|
},
|
|
77
77
|
"dangerouslyDisablePackageManagerCheck": {
|
|
@@ -81,17 +81,17 @@
|
|
|
81
81
|
},
|
|
82
82
|
"cacheDir": {
|
|
83
83
|
"$ref": "#/definitions/RelativeUnixPath",
|
|
84
|
-
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.
|
|
84
|
+
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#cachedir",
|
|
85
85
|
"default": ".turbo/cache"
|
|
86
86
|
},
|
|
87
87
|
"daemon": {
|
|
88
88
|
"type": "boolean",
|
|
89
|
-
"description": "Turborepo runs a background process to pre-calculate some expensive operations. This standalone process (daemon) is a performance optimization, and not required for proper functioning of `turbo`.\n\nDocumentation: https://turborepo.
|
|
89
|
+
"description": "Turborepo runs a background process to pre-calculate some expensive operations. This standalone process (daemon) is a performance optimization, and not required for proper functioning of `turbo`.\n\nDocumentation: https://turborepo.dev/docs/reference/configuration#daemon",
|
|
90
90
|
"default": false
|
|
91
91
|
},
|
|
92
92
|
"envMode": {
|
|
93
93
|
"$ref": "#/definitions/EnvMode",
|
|
94
|
-
"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.
|
|
94
|
+
"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",
|
|
95
95
|
"default": "strict"
|
|
96
96
|
},
|
|
97
97
|
"boundaries": {
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
},
|
|
101
101
|
"noUpdateNotifier": {
|
|
102
102
|
"type": "boolean",
|
|
103
|
-
"description": "When set to `true`, disables the update notification that appears when a new version of `turbo` is available.\n\nDocumentation: https://turborepo.
|
|
103
|
+
"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",
|
|
104
104
|
"default": false
|
|
105
105
|
},
|
|
106
106
|
"futureFlags": {
|
|
@@ -116,12 +116,16 @@
|
|
|
116
116
|
"Pipeline": {
|
|
117
117
|
"type": "object",
|
|
118
118
|
"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."
|
|
122
|
+
},
|
|
119
123
|
"dependsOn": {
|
|
120
124
|
"type": "array",
|
|
121
125
|
"items": {
|
|
122
126
|
"type": "string"
|
|
123
127
|
},
|
|
124
|
-
"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.
|
|
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",
|
|
125
129
|
"default": []
|
|
126
130
|
},
|
|
127
131
|
"env": {
|
|
@@ -129,7 +133,7 @@
|
|
|
129
133
|
"items": {
|
|
130
134
|
"$ref": "#/definitions/EnvWildcard"
|
|
131
135
|
},
|
|
132
|
-
"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.
|
|
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",
|
|
133
137
|
"default": []
|
|
134
138
|
},
|
|
135
139
|
"passThroughEnv": {
|
|
@@ -144,7 +148,7 @@
|
|
|
144
148
|
}
|
|
145
149
|
}
|
|
146
150
|
],
|
|
147
|
-
"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.
|
|
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",
|
|
148
152
|
"default": null
|
|
149
153
|
},
|
|
150
154
|
"outputs": {
|
|
@@ -152,12 +156,12 @@
|
|
|
152
156
|
"items": {
|
|
153
157
|
"type": "string"
|
|
154
158
|
},
|
|
155
|
-
"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.
|
|
159
|
+
"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",
|
|
156
160
|
"default": []
|
|
157
161
|
},
|
|
158
162
|
"cache": {
|
|
159
163
|
"type": "boolean",
|
|
160
|
-
"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.
|
|
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",
|
|
161
165
|
"default": true
|
|
162
166
|
},
|
|
163
167
|
"inputs": {
|
|
@@ -165,27 +169,27 @@
|
|
|
165
169
|
"items": {
|
|
166
170
|
"type": "string"
|
|
167
171
|
},
|
|
168
|
-
"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.
|
|
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",
|
|
169
173
|
"default": []
|
|
170
174
|
},
|
|
171
175
|
"outputLogs": {
|
|
172
176
|
"$ref": "#/definitions/OutputLogs",
|
|
173
|
-
"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.
|
|
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",
|
|
174
178
|
"default": "full"
|
|
175
179
|
},
|
|
176
180
|
"persistent": {
|
|
177
181
|
"type": "boolean",
|
|
178
|
-
"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.
|
|
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",
|
|
179
183
|
"default": false
|
|
180
184
|
},
|
|
181
185
|
"interactive": {
|
|
182
186
|
"type": "boolean",
|
|
183
|
-
"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.
|
|
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",
|
|
184
188
|
"default": false
|
|
185
189
|
},
|
|
186
190
|
"interruptible": {
|
|
187
191
|
"type": "boolean",
|
|
188
|
-
"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.
|
|
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",
|
|
189
193
|
"default": false
|
|
190
194
|
},
|
|
191
195
|
"with": {
|
|
@@ -193,7 +197,7 @@
|
|
|
193
197
|
"items": {
|
|
194
198
|
"type": "string"
|
|
195
199
|
},
|
|
196
|
-
"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.
|
|
200
|
+
"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",
|
|
197
201
|
"default": []
|
|
198
202
|
}
|
|
199
203
|
},
|
|
@@ -216,7 +220,7 @@
|
|
|
216
220
|
},
|
|
217
221
|
"enabled": {
|
|
218
222
|
"type": "boolean",
|
|
219
|
-
"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.
|
|
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",
|
|
220
224
|
"default": true
|
|
221
225
|
},
|
|
222
226
|
"preflight": {
|
|
@@ -226,12 +230,12 @@
|
|
|
226
230
|
},
|
|
227
231
|
"apiUrl": {
|
|
228
232
|
"type": "string",
|
|
229
|
-
"description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.
|
|
233
|
+
"description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
|
|
230
234
|
"default": "https://vercel.com/api"
|
|
231
235
|
},
|
|
232
236
|
"loginUrl": {
|
|
233
237
|
"type": "string",
|
|
234
|
-
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.
|
|
238
|
+
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting",
|
|
235
239
|
"default": "https://vercel.com"
|
|
236
240
|
},
|
|
237
241
|
"timeout": {
|
|
@@ -326,7 +330,7 @@
|
|
|
326
330
|
"properties": {
|
|
327
331
|
"$schema": {
|
|
328
332
|
"type": "string",
|
|
329
|
-
"default": "https://turborepo.
|
|
333
|
+
"default": "https://turborepo.dev/schema.v2.json"
|
|
330
334
|
},
|
|
331
335
|
"tasks": {
|
|
332
336
|
"type": "object",
|
|
@@ -334,7 +338,7 @@
|
|
|
334
338
|
"$ref": "#/definitions/Pipeline",
|
|
335
339
|
"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."
|
|
336
340
|
},
|
|
337
|
-
"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.
|
|
341
|
+
"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",
|
|
338
342
|
"default": {}
|
|
339
343
|
},
|
|
340
344
|
"extends": {
|
package/src/types/config-v1.ts
CHANGED
|
@@ -25,7 +25,7 @@ export interface PipelineV1 {
|
|
|
25
25
|
* same package (e.g. "A package's test and lint commands depend on its own build being
|
|
26
26
|
* completed first.")
|
|
27
27
|
*
|
|
28
|
-
* Documentation: https://turborepo.
|
|
28
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#dependson
|
|
29
29
|
*
|
|
30
30
|
* @defaultValue `[]`
|
|
31
31
|
*/
|
|
@@ -39,7 +39,7 @@ export interface PipelineV1 {
|
|
|
39
39
|
* You no longer need to use the $ prefix.
|
|
40
40
|
* (e.g. $GITHUB_TOKEN → GITHUB_TOKEN)
|
|
41
41
|
*
|
|
42
|
-
* Documentation: https://turborepo.
|
|
42
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#env
|
|
43
43
|
*
|
|
44
44
|
* @defaultValue `[]`
|
|
45
45
|
*/
|
|
@@ -50,7 +50,7 @@ export interface PipelineV1 {
|
|
|
50
50
|
* task's environment, but should not contribute to the task's cache key,
|
|
51
51
|
* e.g. `AWS_SECRET_KEY`.
|
|
52
52
|
*
|
|
53
|
-
* Documentation: https://turborepo.
|
|
53
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#passthroughenv
|
|
54
54
|
*
|
|
55
55
|
* @defaultValue `null`
|
|
56
56
|
*/
|
|
@@ -71,7 +71,7 @@ export interface PipelineV1 {
|
|
|
71
71
|
* produce no artifacts other than logs (such as linters). Logs are always treated as a
|
|
72
72
|
* cacheable artifact and never need to be specified.
|
|
73
73
|
*
|
|
74
|
-
* Documentation: https://turborepo.
|
|
74
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#outputs
|
|
75
75
|
*
|
|
76
76
|
* @defaultValue `[]`
|
|
77
77
|
*/
|
|
@@ -82,7 +82,7 @@ export interface PipelineV1 {
|
|
|
82
82
|
*
|
|
83
83
|
* Setting cache to false is useful for long-running "watch" or development mode tasks.
|
|
84
84
|
*
|
|
85
|
-
* Documentation: https://turborepo.
|
|
85
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#cache
|
|
86
86
|
*
|
|
87
87
|
* @defaultValue `true`
|
|
88
88
|
*/
|
|
@@ -99,7 +99,7 @@ export interface PipelineV1 {
|
|
|
99
99
|
*
|
|
100
100
|
* If omitted or empty, all files in the package are considered as inputs.
|
|
101
101
|
*
|
|
102
|
-
* Documentation: https://turborepo.
|
|
102
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#inputs
|
|
103
103
|
*
|
|
104
104
|
* @defaultValue `[]`
|
|
105
105
|
*/
|
|
@@ -118,7 +118,7 @@ export interface PipelineV1 {
|
|
|
118
118
|
*
|
|
119
119
|
* "none": Hides all task output
|
|
120
120
|
*
|
|
121
|
-
* Documentation: https://turborepo.
|
|
121
|
+
* Documentation: https://turborepo.dev/docs/reference/run#--output-logs-option
|
|
122
122
|
*
|
|
123
123
|
* @defaultValue `"full"`
|
|
124
124
|
*/
|
|
@@ -129,7 +129,7 @@ export interface PipelineV1 {
|
|
|
129
129
|
* turbo that this is a long-running task and will ensure that other tasks
|
|
130
130
|
* cannot depend on it.
|
|
131
131
|
*
|
|
132
|
-
* Documentation: https://turborepo.
|
|
132
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#persistent
|
|
133
133
|
*
|
|
134
134
|
* @defaultValue `false`
|
|
135
135
|
*/
|
|
@@ -140,7 +140,7 @@ export interface PipelineV1 {
|
|
|
140
140
|
* Interactive tasks must be marked with "cache": false as the input
|
|
141
141
|
* they receive from stdin can change the outcome of the task.
|
|
142
142
|
*
|
|
143
|
-
* Documentation: https://turborepo.
|
|
143
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#interactive
|
|
144
144
|
*
|
|
145
145
|
* @defaultValue `false`
|
|
146
146
|
*/
|
|
@@ -148,14 +148,14 @@ export interface PipelineV1 {
|
|
|
148
148
|
}
|
|
149
149
|
|
|
150
150
|
export interface BaseSchemaV1 {
|
|
151
|
-
/** @defaultValue `https://turborepo.
|
|
151
|
+
/** @defaultValue `https://turborepo.dev/schema.v1.json` */
|
|
152
152
|
$schema?: string;
|
|
153
153
|
/**
|
|
154
154
|
* An object representing the task dependency graph of your project. turbo interprets
|
|
155
155
|
* these conventions to schedule, execute, and cache the outputs of tasks in
|
|
156
156
|
* your project.
|
|
157
157
|
*
|
|
158
|
-
* Documentation: https://turborepo.
|
|
158
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#tasks
|
|
159
159
|
*
|
|
160
160
|
* @defaultValue `{}`
|
|
161
161
|
*/
|
|
@@ -201,7 +201,7 @@ export interface RemoteCacheV1 {
|
|
|
201
201
|
* Indicates if the remote cache is enabled. When `false`, Turborepo will disable
|
|
202
202
|
* all remote cache operations, even if the repo has a valid token. If true, remote caching
|
|
203
203
|
* is enabled, but still requires the user to login and link their repo to a remote cache.
|
|
204
|
-
* Documentation: https://turborepo.
|
|
204
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching
|
|
205
205
|
*
|
|
206
206
|
* @defaultValue `true`
|
|
207
207
|
*/
|
|
@@ -223,7 +223,7 @@ export interface RootSchemaV1 extends BaseSchemaV1 {
|
|
|
223
223
|
* that are not represented in the traditional dependency graph
|
|
224
224
|
* (e.g. a root tsconfig.json, jest.config.ts, .eslintrc, etc.)
|
|
225
225
|
*
|
|
226
|
-
* Documentation: https://turborepo.
|
|
226
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globaldependencies
|
|
227
227
|
*
|
|
228
228
|
* @defaultValue `[]`
|
|
229
229
|
*/
|
|
@@ -234,7 +234,7 @@ export interface RootSchemaV1 extends BaseSchemaV1 {
|
|
|
234
234
|
*
|
|
235
235
|
* The variables included in this list will affect all task hashes.
|
|
236
236
|
*
|
|
237
|
-
* Documentation: https://turborepo.
|
|
237
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globalenv
|
|
238
238
|
*
|
|
239
239
|
* @defaultValue `[]`
|
|
240
240
|
*/
|
|
@@ -244,7 +244,7 @@ export interface RootSchemaV1 extends BaseSchemaV1 {
|
|
|
244
244
|
* An allowlist of environment variables that should be made to all tasks, but
|
|
245
245
|
* should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.
|
|
246
246
|
*
|
|
247
|
-
* Documentation: https://turborepo.
|
|
247
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globalpassthroughenv
|
|
248
248
|
*
|
|
249
249
|
* @defaultValue `null`
|
|
250
250
|
*/
|
|
@@ -261,7 +261,7 @@ export interface RootSchemaV1 extends BaseSchemaV1 {
|
|
|
261
261
|
/**
|
|
262
262
|
* Configuration options that control how turbo interfaces with the remote cache.
|
|
263
263
|
*
|
|
264
|
-
* Documentation: https://turborepo.
|
|
264
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching
|
|
265
265
|
*
|
|
266
266
|
* @defaultValue `{}`
|
|
267
267
|
*/
|
|
@@ -270,7 +270,7 @@ export interface RootSchemaV1 extends BaseSchemaV1 {
|
|
|
270
270
|
/**
|
|
271
271
|
* Enable use of the new UI for `turbo`
|
|
272
272
|
*
|
|
273
|
-
* Documentation: https://turborepo.
|
|
273
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#ui
|
|
274
274
|
*
|
|
275
275
|
* @defaultValue `false`
|
|
276
276
|
*/
|
package/src/types/config-v2.ts
CHANGED
|
@@ -13,14 +13,14 @@ export type RelativeUnixPath = string;
|
|
|
13
13
|
export type EnvWildcard = string;
|
|
14
14
|
|
|
15
15
|
export interface BaseSchema {
|
|
16
|
-
/** @defaultValue `https://turborepo.
|
|
16
|
+
/** @defaultValue `https://turborepo.dev/schema.v2.json` */
|
|
17
17
|
$schema?: string;
|
|
18
18
|
/**
|
|
19
19
|
* An object representing the task dependency graph of your project. turbo interprets
|
|
20
20
|
* these conventions to schedule, execute, and cache the outputs of tasks in
|
|
21
21
|
* your project.
|
|
22
22
|
*
|
|
23
|
-
* Documentation: https://turborepo.
|
|
23
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#tasks
|
|
24
24
|
*
|
|
25
25
|
* @defaultValue `{}`
|
|
26
26
|
*/
|
|
@@ -77,7 +77,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
77
77
|
* that are not represented in the traditional dependency graph
|
|
78
78
|
* (e.g. a root tsconfig.json, jest.config.ts, .eslintrc, etc.)
|
|
79
79
|
*
|
|
80
|
-
* Documentation: https://turborepo.
|
|
80
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globaldependencies
|
|
81
81
|
*
|
|
82
82
|
* @defaultValue `[]`
|
|
83
83
|
*/
|
|
@@ -88,7 +88,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
88
88
|
*
|
|
89
89
|
* The variables included in this list will affect all task hashes.
|
|
90
90
|
*
|
|
91
|
-
* Documentation: https://turborepo.
|
|
91
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globalenv
|
|
92
92
|
*
|
|
93
93
|
* @defaultValue `[]`
|
|
94
94
|
*/
|
|
@@ -98,7 +98,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
98
98
|
* An allowlist of environment variables that should be made to all tasks, but
|
|
99
99
|
* should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.
|
|
100
100
|
*
|
|
101
|
-
* Documentation: https://turborepo.
|
|
101
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#globalpassthroughenv
|
|
102
102
|
*
|
|
103
103
|
* @defaultValue `null`
|
|
104
104
|
*/
|
|
@@ -107,7 +107,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
107
107
|
/**
|
|
108
108
|
* Configuration options that control how turbo interfaces with the remote cache.
|
|
109
109
|
*
|
|
110
|
-
* Documentation: https://turborepo.
|
|
110
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching
|
|
111
111
|
*
|
|
112
112
|
* @defaultValue `{}`
|
|
113
113
|
*/
|
|
@@ -116,7 +116,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
116
116
|
/**
|
|
117
117
|
* Enable use of the UI for `turbo`.
|
|
118
118
|
*
|
|
119
|
-
* Documentation: https://turborepo.
|
|
119
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#ui
|
|
120
120
|
*
|
|
121
121
|
* @defaultValue `"stream"`
|
|
122
122
|
*/
|
|
@@ -128,7 +128,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
128
128
|
* - Use `1` to force serial execution (one task at a time).
|
|
129
129
|
* - Use `100%` to use all available logical processors.
|
|
130
130
|
*
|
|
131
|
-
* Documentation: https://turborepo.
|
|
131
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#concurrency
|
|
132
132
|
*
|
|
133
133
|
* @defaultValue `"10"`
|
|
134
134
|
*/
|
|
@@ -149,7 +149,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
149
149
|
/**
|
|
150
150
|
* Specify the filesystem cache directory.
|
|
151
151
|
*
|
|
152
|
-
* Documentation: https://turborepo.
|
|
152
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#cachedir
|
|
153
153
|
*
|
|
154
154
|
* @defaultValue `".turbo/cache"`
|
|
155
155
|
*/
|
|
@@ -158,7 +158,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
158
158
|
/**
|
|
159
159
|
* Turborepo runs a background process to pre-calculate some expensive operations. This standalone process (daemon) is a performance optimization, and not required for proper functioning of `turbo`.
|
|
160
160
|
*
|
|
161
|
-
* Documentation: https://turborepo.
|
|
161
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#daemon
|
|
162
162
|
*
|
|
163
163
|
* @defaultValue `false`
|
|
164
164
|
*/
|
|
@@ -170,7 +170,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
170
170
|
* - `"strict"`: Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`.
|
|
171
171
|
* - `"loose"`: Allow all environment variables for the process to be available.
|
|
172
172
|
*
|
|
173
|
-
* Documentation: https://turborepo.
|
|
173
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#envmode
|
|
174
174
|
*
|
|
175
175
|
* @defaultValue `"strict"`
|
|
176
176
|
*/
|
|
@@ -184,7 +184,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
184
184
|
/**
|
|
185
185
|
* When set to `true`, disables the update notification that appears when a new version of `turbo` is available.
|
|
186
186
|
*
|
|
187
|
-
* Documentation: https://turborepo.
|
|
187
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#noupdatenotifier
|
|
188
188
|
*
|
|
189
189
|
* @defaultValue `false`
|
|
190
190
|
*/
|
|
@@ -199,6 +199,14 @@ export interface RootSchema extends BaseSchema {
|
|
|
199
199
|
}
|
|
200
200
|
|
|
201
201
|
export interface Pipeline {
|
|
202
|
+
/**
|
|
203
|
+
* A human-readable description of what this task does.
|
|
204
|
+
*
|
|
205
|
+
* This field is for documentation purposes only and does not affect
|
|
206
|
+
* task execution or caching behavior.
|
|
207
|
+
*/
|
|
208
|
+
description?: string;
|
|
209
|
+
|
|
202
210
|
/**
|
|
203
211
|
* The list of tasks that this task depends on.
|
|
204
212
|
*
|
|
@@ -211,7 +219,7 @@ export interface Pipeline {
|
|
|
211
219
|
* same package (e.g. "A package's test and lint commands depend on its own build being
|
|
212
220
|
* completed first.")
|
|
213
221
|
*
|
|
214
|
-
* Documentation: https://turborepo.
|
|
222
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#dependson
|
|
215
223
|
*
|
|
216
224
|
* @defaultValue `[]`
|
|
217
225
|
*/
|
|
@@ -225,7 +233,7 @@ export interface Pipeline {
|
|
|
225
233
|
* You no longer need to use the $ prefix.
|
|
226
234
|
* (e.g. $GITHUB_TOKEN → GITHUB_TOKEN)
|
|
227
235
|
*
|
|
228
|
-
* Documentation: https://turborepo.
|
|
236
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#env
|
|
229
237
|
*
|
|
230
238
|
* @defaultValue `[]`
|
|
231
239
|
*/
|
|
@@ -236,7 +244,7 @@ export interface Pipeline {
|
|
|
236
244
|
* task's environment, but should not contribute to the task's cache key,
|
|
237
245
|
* e.g. `AWS_SECRET_KEY`.
|
|
238
246
|
*
|
|
239
|
-
* Documentation: https://turborepo.
|
|
247
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#passthroughenv
|
|
240
248
|
*
|
|
241
249
|
* @defaultValue `null`
|
|
242
250
|
*/
|
|
@@ -249,7 +257,7 @@ export interface Pipeline {
|
|
|
249
257
|
* produce no artifacts other than logs (such as linters). Logs are always treated as a
|
|
250
258
|
* cacheable artifact and never need to be specified.
|
|
251
259
|
*
|
|
252
|
-
* Documentation: https://turborepo.
|
|
260
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#outputs
|
|
253
261
|
*
|
|
254
262
|
* @defaultValue `[]`
|
|
255
263
|
*/
|
|
@@ -260,7 +268,7 @@ export interface Pipeline {
|
|
|
260
268
|
*
|
|
261
269
|
* Setting cache to false is useful for long-running "watch" or development mode tasks.
|
|
262
270
|
*
|
|
263
|
-
* Documentation: https://turborepo.
|
|
271
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#cache
|
|
264
272
|
*
|
|
265
273
|
* @defaultValue `true`
|
|
266
274
|
*/
|
|
@@ -277,7 +285,7 @@ export interface Pipeline {
|
|
|
277
285
|
*
|
|
278
286
|
* If omitted or empty, all files in the package are considered as inputs.
|
|
279
287
|
*
|
|
280
|
-
* Documentation: https://turborepo.
|
|
288
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#inputs
|
|
281
289
|
*
|
|
282
290
|
* @defaultValue `[]`
|
|
283
291
|
*/
|
|
@@ -296,7 +304,7 @@ export interface Pipeline {
|
|
|
296
304
|
*
|
|
297
305
|
* "none": Hides all task output
|
|
298
306
|
*
|
|
299
|
-
* Documentation: https://turborepo.
|
|
307
|
+
* Documentation: https://turborepo.dev/docs/reference/run#--output-logs-option
|
|
300
308
|
*
|
|
301
309
|
* @defaultValue `"full"`
|
|
302
310
|
*/
|
|
@@ -307,7 +315,7 @@ export interface Pipeline {
|
|
|
307
315
|
* turbo that this is a long-running task and will ensure that other tasks
|
|
308
316
|
* cannot depend on it.
|
|
309
317
|
*
|
|
310
|
-
* Documentation: https://turborepo.
|
|
318
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#persistent
|
|
311
319
|
*
|
|
312
320
|
* @defaultValue `false`
|
|
313
321
|
*/
|
|
@@ -318,7 +326,7 @@ export interface Pipeline {
|
|
|
318
326
|
* Interactive tasks must be marked with "cache": false as the input
|
|
319
327
|
* they receive from stdin can change the outcome of the task.
|
|
320
328
|
*
|
|
321
|
-
* Documentation: https://turborepo.
|
|
329
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#interactive
|
|
322
330
|
*
|
|
323
331
|
* @defaultValue `false`
|
|
324
332
|
*/
|
|
@@ -331,7 +339,7 @@ export interface Pipeline {
|
|
|
331
339
|
* not be restarted by default. To enable restarting persistent tasks, set
|
|
332
340
|
* `interruptible` to true.
|
|
333
341
|
*
|
|
334
|
-
* Documentation: https://turborepo.
|
|
342
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#interruptible
|
|
335
343
|
*
|
|
336
344
|
* @defaultValue `false`
|
|
337
345
|
*/
|
|
@@ -342,7 +350,7 @@ export interface Pipeline {
|
|
|
342
350
|
*
|
|
343
351
|
* Tasks in this list will not be run until completion before this task starts execution.
|
|
344
352
|
*
|
|
345
|
-
* Documentation: https://turborepo.
|
|
353
|
+
* Documentation: https://turborepo.dev/docs/reference/configuration#with
|
|
346
354
|
*
|
|
347
355
|
* @defaultValue `[]`
|
|
348
356
|
*/
|
|
@@ -364,7 +372,7 @@ export interface RemoteCache {
|
|
|
364
372
|
* Indicates if the remote cache is enabled. When `false`, Turborepo will disable
|
|
365
373
|
* all remote cache operations, even if the repo has a valid token. If true, remote caching
|
|
366
374
|
* is enabled, but still requires the user to login and link their repo to a remote cache.
|
|
367
|
-
* Documentation: https://turborepo.
|
|
375
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching
|
|
368
376
|
*
|
|
369
377
|
* @defaultValue `true`
|
|
370
378
|
*/
|
|
@@ -381,14 +389,14 @@ export interface RemoteCache {
|
|
|
381
389
|
preflight?: boolean;
|
|
382
390
|
/**
|
|
383
391
|
* Set endpoint for API calls to the remote cache.
|
|
384
|
-
* Documentation: https://turborepo.
|
|
392
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting
|
|
385
393
|
*
|
|
386
394
|
* @defaultValue `"https://vercel.com/api"`
|
|
387
395
|
*/
|
|
388
396
|
apiUrl?: string;
|
|
389
397
|
/**
|
|
390
398
|
* Set endpoint for requesting tokens during `turbo login`.
|
|
391
|
-
* Documentation: https://turborepo.
|
|
399
|
+
* Documentation: https://turborepo.dev/docs/core-concepts/remote-caching#self-hosting
|
|
392
400
|
*
|
|
393
401
|
* @defaultValue `"https://vercel.com"`
|
|
394
402
|
*/
|