@turbo/types 2.5.1-canary.2 → 2.5.2-canary.0
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/README.md +1 -1
- package/package.json +2 -2
- package/schemas/schema.json +31 -26
- package/schemas/schema.v1.json +19 -19
- package/schemas/schema.v2.json +31 -26
- package/src/types/config-v1.ts +17 -17
- package/src/types/config-v2.ts +36 -24
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 [
|
|
7
|
+
For more information about Turborepo, visit [turborepo.com](https://turborepo.com) and follow us on X ([@turborepo](https://x.com/turborepo))!
|
package/package.json
CHANGED
package/schemas/schema.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"properties": {
|
|
18
18
|
"$schema": {
|
|
19
19
|
"type": "string",
|
|
20
|
-
"default": "https://
|
|
20
|
+
"default": "https://turborepo.com/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://
|
|
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.com/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://
|
|
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.com/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://
|
|
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.com/docs/reference/configuration#globalenv",
|
|
45
45
|
"default": []
|
|
46
46
|
},
|
|
47
47
|
"globalPassThroughEnv": {
|
|
@@ -56,19 +56,24 @@
|
|
|
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://
|
|
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.com/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://
|
|
64
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.com/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://
|
|
69
|
+
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#ui",
|
|
70
70
|
"default": "stream"
|
|
71
71
|
},
|
|
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.com/docs/reference/configuration#concurrency",
|
|
75
|
+
"default": "10"
|
|
76
|
+
},
|
|
72
77
|
"dangerouslyDisablePackageManagerCheck": {
|
|
73
78
|
"type": "boolean",
|
|
74
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.",
|
|
@@ -76,17 +81,17 @@
|
|
|
76
81
|
},
|
|
77
82
|
"cacheDir": {
|
|
78
83
|
"$ref": "#/definitions/RelativeUnixPath",
|
|
79
|
-
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://
|
|
84
|
+
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#cachedir",
|
|
80
85
|
"default": ".turbo/cache"
|
|
81
86
|
},
|
|
82
87
|
"daemon": {
|
|
83
88
|
"type": "boolean",
|
|
84
|
-
"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://
|
|
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.com/docs/reference/configuration#daemon",
|
|
85
90
|
"default": false
|
|
86
91
|
},
|
|
87
92
|
"envMode": {
|
|
88
93
|
"$ref": "#/definitions/EnvMode",
|
|
89
|
-
"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://
|
|
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.com/docs/reference/configuration#envmode",
|
|
90
95
|
"default": "strict"
|
|
91
96
|
},
|
|
92
97
|
"boundaries": {
|
|
@@ -107,7 +112,7 @@
|
|
|
107
112
|
"items": {
|
|
108
113
|
"type": "string"
|
|
109
114
|
},
|
|
110
|
-
"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://
|
|
115
|
+
"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.com/docs/reference/configuration#dependson",
|
|
111
116
|
"default": []
|
|
112
117
|
},
|
|
113
118
|
"env": {
|
|
@@ -115,7 +120,7 @@
|
|
|
115
120
|
"items": {
|
|
116
121
|
"$ref": "#/definitions/EnvWildcard"
|
|
117
122
|
},
|
|
118
|
-
"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://
|
|
123
|
+
"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.com/docs/reference/configuration#env",
|
|
119
124
|
"default": []
|
|
120
125
|
},
|
|
121
126
|
"passThroughEnv": {
|
|
@@ -130,7 +135,7 @@
|
|
|
130
135
|
}
|
|
131
136
|
}
|
|
132
137
|
],
|
|
133
|
-
"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://
|
|
138
|
+
"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.com/docs/reference/configuration#passthroughenv",
|
|
134
139
|
"default": null
|
|
135
140
|
},
|
|
136
141
|
"outputs": {
|
|
@@ -138,12 +143,12 @@
|
|
|
138
143
|
"items": {
|
|
139
144
|
"type": "string"
|
|
140
145
|
},
|
|
141
|
-
"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://
|
|
146
|
+
"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.com/docs/reference/configuration#outputs",
|
|
142
147
|
"default": []
|
|
143
148
|
},
|
|
144
149
|
"cache": {
|
|
145
150
|
"type": "boolean",
|
|
146
|
-
"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://
|
|
151
|
+
"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.com/docs/reference/configuration#cache",
|
|
147
152
|
"default": true
|
|
148
153
|
},
|
|
149
154
|
"inputs": {
|
|
@@ -151,27 +156,27 @@
|
|
|
151
156
|
"items": {
|
|
152
157
|
"type": "string"
|
|
153
158
|
},
|
|
154
|
-
"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://
|
|
159
|
+
"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.com/docs/reference/configuration#inputs",
|
|
155
160
|
"default": []
|
|
156
161
|
},
|
|
157
162
|
"outputLogs": {
|
|
158
163
|
"$ref": "#/definitions/OutputLogs",
|
|
159
|
-
"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://
|
|
164
|
+
"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.com/docs/reference/run#--output-logs-option",
|
|
160
165
|
"default": "full"
|
|
161
166
|
},
|
|
162
167
|
"persistent": {
|
|
163
168
|
"type": "boolean",
|
|
164
|
-
"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://
|
|
169
|
+
"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.com/docs/reference/configuration#persistent",
|
|
165
170
|
"default": false
|
|
166
171
|
},
|
|
167
172
|
"interactive": {
|
|
168
173
|
"type": "boolean",
|
|
169
|
-
"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://
|
|
174
|
+
"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.com/docs/reference/configuration#interactive",
|
|
170
175
|
"default": false
|
|
171
176
|
},
|
|
172
177
|
"interruptible": {
|
|
173
178
|
"type": "boolean",
|
|
174
|
-
"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://
|
|
179
|
+
"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.com/docs/reference/configuration#interruptible",
|
|
175
180
|
"default": false
|
|
176
181
|
},
|
|
177
182
|
"with": {
|
|
@@ -179,7 +184,7 @@
|
|
|
179
184
|
"items": {
|
|
180
185
|
"type": "string"
|
|
181
186
|
},
|
|
182
|
-
"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://
|
|
187
|
+
"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.com/docs/reference/configuration#with",
|
|
183
188
|
"default": []
|
|
184
189
|
}
|
|
185
190
|
},
|
|
@@ -208,7 +213,7 @@
|
|
|
208
213
|
},
|
|
209
214
|
"enabled": {
|
|
210
215
|
"type": "boolean",
|
|
211
|
-
"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://
|
|
216
|
+
"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.com/docs/core-concepts/remote-caching",
|
|
212
217
|
"default": true
|
|
213
218
|
},
|
|
214
219
|
"preflight": {
|
|
@@ -218,12 +223,12 @@
|
|
|
218
223
|
},
|
|
219
224
|
"apiUrl": {
|
|
220
225
|
"type": "string",
|
|
221
|
-
"description": "Set endpoint for API calls to the remote cache. Documentation: https://
|
|
226
|
+
"description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
222
227
|
"default": "https://vercel.com/api"
|
|
223
228
|
},
|
|
224
229
|
"loginUrl": {
|
|
225
230
|
"type": "string",
|
|
226
|
-
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://
|
|
231
|
+
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
227
232
|
"default": "https://vercel.com"
|
|
228
233
|
},
|
|
229
234
|
"timeout": {
|
|
@@ -324,7 +329,7 @@
|
|
|
324
329
|
"properties": {
|
|
325
330
|
"$schema": {
|
|
326
331
|
"type": "string",
|
|
327
|
-
"default": "https://
|
|
332
|
+
"default": "https://turborepo.com/schema.v2.json"
|
|
328
333
|
},
|
|
329
334
|
"tasks": {
|
|
330
335
|
"type": "object",
|
|
@@ -332,7 +337,7 @@
|
|
|
332
337
|
"$ref": "#/definitions/Pipeline",
|
|
333
338
|
"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."
|
|
334
339
|
},
|
|
335
|
-
"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://
|
|
340
|
+
"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.com/docs/reference/configuration#tasks",
|
|
336
341
|
"default": {}
|
|
337
342
|
},
|
|
338
343
|
"extends": {
|
package/schemas/schema.v1.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"properties": {
|
|
18
18
|
"$schema": {
|
|
19
19
|
"type": "string",
|
|
20
|
-
"default": "https://
|
|
20
|
+
"default": "https://turborepo.com/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://
|
|
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.com/docs/reference/configuration#tasks",
|
|
29
29
|
"default": {}
|
|
30
30
|
},
|
|
31
31
|
"extends": {
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
"items": {
|
|
54
54
|
"type": "string"
|
|
55
55
|
},
|
|
56
|
-
"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://
|
|
56
|
+
"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.com/docs/reference/configuration#dependson",
|
|
57
57
|
"default": []
|
|
58
58
|
},
|
|
59
59
|
"env": {
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
"items": {
|
|
62
62
|
"$ref": "#/definitions/EnvWildcardV1"
|
|
63
63
|
},
|
|
64
|
-
"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://
|
|
64
|
+
"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.com/docs/reference/configuration#env",
|
|
65
65
|
"default": []
|
|
66
66
|
},
|
|
67
67
|
"passThroughEnv": {
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
}
|
|
77
77
|
}
|
|
78
78
|
],
|
|
79
|
-
"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://
|
|
79
|
+
"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.com/docs/reference/configuration#passthroughenv",
|
|
80
80
|
"default": null
|
|
81
81
|
},
|
|
82
82
|
"dotEnv": {
|
|
@@ -99,12 +99,12 @@
|
|
|
99
99
|
"items": {
|
|
100
100
|
"type": "string"
|
|
101
101
|
},
|
|
102
|
-
"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://
|
|
102
|
+
"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.com/docs/reference/configuration#outputs",
|
|
103
103
|
"default": []
|
|
104
104
|
},
|
|
105
105
|
"cache": {
|
|
106
106
|
"type": "boolean",
|
|
107
|
-
"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://
|
|
107
|
+
"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.com/docs/reference/configuration#cache",
|
|
108
108
|
"default": true
|
|
109
109
|
},
|
|
110
110
|
"inputs": {
|
|
@@ -112,22 +112,22 @@
|
|
|
112
112
|
"items": {
|
|
113
113
|
"type": "string"
|
|
114
114
|
},
|
|
115
|
-
"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://
|
|
115
|
+
"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.com/docs/reference/configuration#inputs",
|
|
116
116
|
"default": []
|
|
117
117
|
},
|
|
118
118
|
"outputMode": {
|
|
119
119
|
"$ref": "#/definitions/OutputModeV1",
|
|
120
|
-
"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://
|
|
120
|
+
"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.com/docs/reference/run#--output-logs-option",
|
|
121
121
|
"default": "full"
|
|
122
122
|
},
|
|
123
123
|
"persistent": {
|
|
124
124
|
"type": "boolean",
|
|
125
|
-
"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://
|
|
125
|
+
"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.com/docs/reference/configuration#persistent",
|
|
126
126
|
"default": false
|
|
127
127
|
},
|
|
128
128
|
"interactive": {
|
|
129
129
|
"type": "boolean",
|
|
130
|
-
"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://
|
|
130
|
+
"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.com/docs/reference/configuration#interactive",
|
|
131
131
|
"default": false
|
|
132
132
|
}
|
|
133
133
|
},
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
"properties": {
|
|
155
155
|
"$schema": {
|
|
156
156
|
"type": "string",
|
|
157
|
-
"default": "https://
|
|
157
|
+
"default": "https://turborepo.com/schema.v1.json"
|
|
158
158
|
},
|
|
159
159
|
"pipeline": {
|
|
160
160
|
"type": "object",
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
"$ref": "#/definitions/PipelineV1",
|
|
163
163
|
"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."
|
|
164
164
|
},
|
|
165
|
-
"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://
|
|
165
|
+
"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.com/docs/reference/configuration#tasks",
|
|
166
166
|
"default": {}
|
|
167
167
|
},
|
|
168
168
|
"globalDependencies": {
|
|
@@ -170,7 +170,7 @@
|
|
|
170
170
|
"items": {
|
|
171
171
|
"type": "string"
|
|
172
172
|
},
|
|
173
|
-
"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://
|
|
173
|
+
"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.com/docs/reference/configuration#globaldependencies",
|
|
174
174
|
"default": []
|
|
175
175
|
},
|
|
176
176
|
"globalEnv": {
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
"items": {
|
|
179
179
|
"$ref": "#/definitions/EnvWildcardV1"
|
|
180
180
|
},
|
|
181
|
-
"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://
|
|
181
|
+
"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.com/docs/reference/configuration#globalenv",
|
|
182
182
|
"default": []
|
|
183
183
|
},
|
|
184
184
|
"globalPassThroughEnv": {
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
}
|
|
194
194
|
}
|
|
195
195
|
],
|
|
196
|
-
"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://
|
|
196
|
+
"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.com/docs/reference/configuration#globalpassthroughenv",
|
|
197
197
|
"default": null
|
|
198
198
|
},
|
|
199
199
|
"globalDotEnv": {
|
|
@@ -213,12 +213,12 @@
|
|
|
213
213
|
},
|
|
214
214
|
"remoteCache": {
|
|
215
215
|
"$ref": "#/definitions/RemoteCacheV1",
|
|
216
|
-
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://
|
|
216
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.com/docs/core-concepts/remote-caching",
|
|
217
217
|
"default": {}
|
|
218
218
|
},
|
|
219
219
|
"experimentalUI": {
|
|
220
220
|
"type": "boolean",
|
|
221
|
-
"description": "Enable use of the new UI for `turbo`\n\nDocumentation: https://
|
|
221
|
+
"description": "Enable use of the new UI for `turbo`\n\nDocumentation: https://turborepo.com/docs/reference/configuration#ui",
|
|
222
222
|
"default": false
|
|
223
223
|
}
|
|
224
224
|
},
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
},
|
|
238
238
|
"enabled": {
|
|
239
239
|
"type": "boolean",
|
|
240
|
-
"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://
|
|
240
|
+
"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.com/docs/core-concepts/remote-caching",
|
|
241
241
|
"default": true
|
|
242
242
|
}
|
|
243
243
|
},
|
package/schemas/schema.v2.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"properties": {
|
|
18
18
|
"$schema": {
|
|
19
19
|
"type": "string",
|
|
20
|
-
"default": "https://
|
|
20
|
+
"default": "https://turborepo.com/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://
|
|
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.com/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://
|
|
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.com/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://
|
|
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.com/docs/reference/configuration#globalenv",
|
|
45
45
|
"default": []
|
|
46
46
|
},
|
|
47
47
|
"globalPassThroughEnv": {
|
|
@@ -56,19 +56,24 @@
|
|
|
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://
|
|
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.com/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://
|
|
64
|
+
"description": "Configuration options that control how turbo interfaces with the remote cache.\n\nDocumentation: https://turborepo.com/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://
|
|
69
|
+
"description": "Enable use of the UI for `turbo`.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#ui",
|
|
70
70
|
"default": "stream"
|
|
71
71
|
},
|
|
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.com/docs/reference/configuration#concurrency",
|
|
75
|
+
"default": "10"
|
|
76
|
+
},
|
|
72
77
|
"dangerouslyDisablePackageManagerCheck": {
|
|
73
78
|
"type": "boolean",
|
|
74
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.",
|
|
@@ -76,17 +81,17 @@
|
|
|
76
81
|
},
|
|
77
82
|
"cacheDir": {
|
|
78
83
|
"$ref": "#/definitions/RelativeUnixPath",
|
|
79
|
-
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://
|
|
84
|
+
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#cachedir",
|
|
80
85
|
"default": ".turbo/cache"
|
|
81
86
|
},
|
|
82
87
|
"daemon": {
|
|
83
88
|
"type": "boolean",
|
|
84
|
-
"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://
|
|
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.com/docs/reference/configuration#daemon",
|
|
85
90
|
"default": false
|
|
86
91
|
},
|
|
87
92
|
"envMode": {
|
|
88
93
|
"$ref": "#/definitions/EnvMode",
|
|
89
|
-
"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://
|
|
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.com/docs/reference/configuration#envmode",
|
|
90
95
|
"default": "strict"
|
|
91
96
|
},
|
|
92
97
|
"boundaries": {
|
|
@@ -107,7 +112,7 @@
|
|
|
107
112
|
"items": {
|
|
108
113
|
"type": "string"
|
|
109
114
|
},
|
|
110
|
-
"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://
|
|
115
|
+
"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.com/docs/reference/configuration#dependson",
|
|
111
116
|
"default": []
|
|
112
117
|
},
|
|
113
118
|
"env": {
|
|
@@ -115,7 +120,7 @@
|
|
|
115
120
|
"items": {
|
|
116
121
|
"$ref": "#/definitions/EnvWildcard"
|
|
117
122
|
},
|
|
118
|
-
"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://
|
|
123
|
+
"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.com/docs/reference/configuration#env",
|
|
119
124
|
"default": []
|
|
120
125
|
},
|
|
121
126
|
"passThroughEnv": {
|
|
@@ -130,7 +135,7 @@
|
|
|
130
135
|
}
|
|
131
136
|
}
|
|
132
137
|
],
|
|
133
|
-
"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://
|
|
138
|
+
"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.com/docs/reference/configuration#passthroughenv",
|
|
134
139
|
"default": null
|
|
135
140
|
},
|
|
136
141
|
"outputs": {
|
|
@@ -138,12 +143,12 @@
|
|
|
138
143
|
"items": {
|
|
139
144
|
"type": "string"
|
|
140
145
|
},
|
|
141
|
-
"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://
|
|
146
|
+
"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.com/docs/reference/configuration#outputs",
|
|
142
147
|
"default": []
|
|
143
148
|
},
|
|
144
149
|
"cache": {
|
|
145
150
|
"type": "boolean",
|
|
146
|
-
"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://
|
|
151
|
+
"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.com/docs/reference/configuration#cache",
|
|
147
152
|
"default": true
|
|
148
153
|
},
|
|
149
154
|
"inputs": {
|
|
@@ -151,27 +156,27 @@
|
|
|
151
156
|
"items": {
|
|
152
157
|
"type": "string"
|
|
153
158
|
},
|
|
154
|
-
"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://
|
|
159
|
+
"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.com/docs/reference/configuration#inputs",
|
|
155
160
|
"default": []
|
|
156
161
|
},
|
|
157
162
|
"outputLogs": {
|
|
158
163
|
"$ref": "#/definitions/OutputLogs",
|
|
159
|
-
"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://
|
|
164
|
+
"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.com/docs/reference/run#--output-logs-option",
|
|
160
165
|
"default": "full"
|
|
161
166
|
},
|
|
162
167
|
"persistent": {
|
|
163
168
|
"type": "boolean",
|
|
164
|
-
"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://
|
|
169
|
+
"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.com/docs/reference/configuration#persistent",
|
|
165
170
|
"default": false
|
|
166
171
|
},
|
|
167
172
|
"interactive": {
|
|
168
173
|
"type": "boolean",
|
|
169
|
-
"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://
|
|
174
|
+
"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.com/docs/reference/configuration#interactive",
|
|
170
175
|
"default": false
|
|
171
176
|
},
|
|
172
177
|
"interruptible": {
|
|
173
178
|
"type": "boolean",
|
|
174
|
-
"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://
|
|
179
|
+
"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.com/docs/reference/configuration#interruptible",
|
|
175
180
|
"default": false
|
|
176
181
|
},
|
|
177
182
|
"with": {
|
|
@@ -179,7 +184,7 @@
|
|
|
179
184
|
"items": {
|
|
180
185
|
"type": "string"
|
|
181
186
|
},
|
|
182
|
-
"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://
|
|
187
|
+
"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.com/docs/reference/configuration#with",
|
|
183
188
|
"default": []
|
|
184
189
|
}
|
|
185
190
|
},
|
|
@@ -208,7 +213,7 @@
|
|
|
208
213
|
},
|
|
209
214
|
"enabled": {
|
|
210
215
|
"type": "boolean",
|
|
211
|
-
"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://
|
|
216
|
+
"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.com/docs/core-concepts/remote-caching",
|
|
212
217
|
"default": true
|
|
213
218
|
},
|
|
214
219
|
"preflight": {
|
|
@@ -218,12 +223,12 @@
|
|
|
218
223
|
},
|
|
219
224
|
"apiUrl": {
|
|
220
225
|
"type": "string",
|
|
221
|
-
"description": "Set endpoint for API calls to the remote cache. Documentation: https://
|
|
226
|
+
"description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
222
227
|
"default": "https://vercel.com/api"
|
|
223
228
|
},
|
|
224
229
|
"loginUrl": {
|
|
225
230
|
"type": "string",
|
|
226
|
-
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://
|
|
231
|
+
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
227
232
|
"default": "https://vercel.com"
|
|
228
233
|
},
|
|
229
234
|
"timeout": {
|
|
@@ -324,7 +329,7 @@
|
|
|
324
329
|
"properties": {
|
|
325
330
|
"$schema": {
|
|
326
331
|
"type": "string",
|
|
327
|
-
"default": "https://
|
|
332
|
+
"default": "https://turborepo.com/schema.v2.json"
|
|
328
333
|
},
|
|
329
334
|
"tasks": {
|
|
330
335
|
"type": "object",
|
|
@@ -332,7 +337,7 @@
|
|
|
332
337
|
"$ref": "#/definitions/Pipeline",
|
|
333
338
|
"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."
|
|
334
339
|
},
|
|
335
|
-
"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://
|
|
340
|
+
"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.com/docs/reference/configuration#tasks",
|
|
336
341
|
"default": {}
|
|
337
342
|
},
|
|
338
343
|
"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://
|
|
28
|
+
* Documentation: https://turborepo.com/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://
|
|
42
|
+
* Documentation: https://turborepo.com/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://
|
|
53
|
+
* Documentation: https://turborepo.com/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://
|
|
74
|
+
* Documentation: https://turborepo.com/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://
|
|
85
|
+
* Documentation: https://turborepo.com/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://
|
|
102
|
+
* Documentation: https://turborepo.com/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://
|
|
121
|
+
* Documentation: https://turborepo.com/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://
|
|
132
|
+
* Documentation: https://turborepo.com/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://
|
|
143
|
+
* Documentation: https://turborepo.com/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://
|
|
151
|
+
/** @defaultValue `https://turborepo.com/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://
|
|
158
|
+
* Documentation: https://turborepo.com/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://
|
|
204
|
+
* Documentation: https://turborepo.com/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://
|
|
226
|
+
* Documentation: https://turborepo.com/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://
|
|
237
|
+
* Documentation: https://turborepo.com/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://
|
|
247
|
+
* Documentation: https://turborepo.com/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://
|
|
264
|
+
* Documentation: https://turborepo.com/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://
|
|
273
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#ui
|
|
274
274
|
*
|
|
275
275
|
* @defaultValue `false`
|
|
276
276
|
*/
|
package/src/types/config-v2.ts
CHANGED
|
@@ -14,14 +14,14 @@ export type RelativeUnixPath = string;
|
|
|
14
14
|
export type EnvWildcard = string;
|
|
15
15
|
|
|
16
16
|
export interface BaseSchema {
|
|
17
|
-
/** @defaultValue `https://
|
|
17
|
+
/** @defaultValue `https://turborepo.com/schema.v2.json` */
|
|
18
18
|
$schema?: string;
|
|
19
19
|
/**
|
|
20
20
|
* An object representing the task dependency graph of your project. turbo interprets
|
|
21
21
|
* these conventions to schedule, execute, and cache the outputs of tasks in
|
|
22
22
|
* your project.
|
|
23
23
|
*
|
|
24
|
-
* Documentation: https://
|
|
24
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#tasks
|
|
25
25
|
*
|
|
26
26
|
* @defaultValue `{}`
|
|
27
27
|
*/
|
|
@@ -78,7 +78,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
78
78
|
* that are not represented in the traditional dependency graph
|
|
79
79
|
* (e.g. a root tsconfig.json, jest.config.ts, .eslintrc, etc.)
|
|
80
80
|
*
|
|
81
|
-
* Documentation: https://
|
|
81
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#globaldependencies
|
|
82
82
|
*
|
|
83
83
|
* @defaultValue `[]`
|
|
84
84
|
*/
|
|
@@ -89,7 +89,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
89
89
|
*
|
|
90
90
|
* The variables included in this list will affect all task hashes.
|
|
91
91
|
*
|
|
92
|
-
* Documentation: https://
|
|
92
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#globalenv
|
|
93
93
|
*
|
|
94
94
|
* @defaultValue `[]`
|
|
95
95
|
*/
|
|
@@ -99,7 +99,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
99
99
|
* An allowlist of environment variables that should be made to all tasks, but
|
|
100
100
|
* should not contribute to the task's cache key, e.g. `AWS_SECRET_KEY`.
|
|
101
101
|
*
|
|
102
|
-
* Documentation: https://
|
|
102
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#globalpassthroughenv
|
|
103
103
|
*
|
|
104
104
|
* @defaultValue `null`
|
|
105
105
|
*/
|
|
@@ -108,7 +108,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
108
108
|
/**
|
|
109
109
|
* Configuration options that control how turbo interfaces with the remote cache.
|
|
110
110
|
*
|
|
111
|
-
* Documentation: https://
|
|
111
|
+
* Documentation: https://turborepo.com/docs/core-concepts/remote-caching
|
|
112
112
|
*
|
|
113
113
|
* @defaultValue `{}`
|
|
114
114
|
*/
|
|
@@ -117,12 +117,24 @@ export interface RootSchema extends BaseSchema {
|
|
|
117
117
|
/**
|
|
118
118
|
* Enable use of the UI for `turbo`.
|
|
119
119
|
*
|
|
120
|
-
* Documentation: https://
|
|
120
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#ui
|
|
121
121
|
*
|
|
122
122
|
* @defaultValue `"stream"`
|
|
123
123
|
*/
|
|
124
124
|
ui?: UI;
|
|
125
125
|
|
|
126
|
+
/**
|
|
127
|
+
* Set/limit the maximum concurrency for task execution. Must be an integer greater than or equal to `1` or a percentage value like `50%`.
|
|
128
|
+
*
|
|
129
|
+
* - Use `1` to force serial execution (one task at a time).
|
|
130
|
+
* - Use `100%` to use all available logical processors.
|
|
131
|
+
*
|
|
132
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#concurrency
|
|
133
|
+
*
|
|
134
|
+
* @defaultValue `"10"`
|
|
135
|
+
*/
|
|
136
|
+
concurrency?: string;
|
|
137
|
+
|
|
126
138
|
/**
|
|
127
139
|
* Disable check for `packageManager` in root `package.json`
|
|
128
140
|
*
|
|
@@ -138,7 +150,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
138
150
|
/**
|
|
139
151
|
* Specify the filesystem cache directory.
|
|
140
152
|
*
|
|
141
|
-
* Documentation: https://
|
|
153
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#cachedir
|
|
142
154
|
*
|
|
143
155
|
* @defaultValue `".turbo/cache"`
|
|
144
156
|
*/
|
|
@@ -147,7 +159,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
147
159
|
/**
|
|
148
160
|
* 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`.
|
|
149
161
|
*
|
|
150
|
-
* Documentation: https://
|
|
162
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#daemon
|
|
151
163
|
*
|
|
152
164
|
* @defaultValue `false`
|
|
153
165
|
*/
|
|
@@ -159,7 +171,7 @@ export interface RootSchema extends BaseSchema {
|
|
|
159
171
|
* - `"strict"`: Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`.
|
|
160
172
|
* - `"loose"`: Allow all environment variables for the process to be available.
|
|
161
173
|
*
|
|
162
|
-
* Documentation: https://
|
|
174
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#envmode
|
|
163
175
|
*
|
|
164
176
|
* @defaultValue `"strict"`
|
|
165
177
|
*/
|
|
@@ -184,7 +196,7 @@ export interface Pipeline {
|
|
|
184
196
|
* same package (e.g. "A package's test and lint commands depend on its own build being
|
|
185
197
|
* completed first.")
|
|
186
198
|
*
|
|
187
|
-
* Documentation: https://
|
|
199
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#dependson
|
|
188
200
|
*
|
|
189
201
|
* @defaultValue `[]`
|
|
190
202
|
*/
|
|
@@ -198,7 +210,7 @@ export interface Pipeline {
|
|
|
198
210
|
* You no longer need to use the $ prefix.
|
|
199
211
|
* (e.g. $GITHUB_TOKEN → GITHUB_TOKEN)
|
|
200
212
|
*
|
|
201
|
-
* Documentation: https://
|
|
213
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#env
|
|
202
214
|
*
|
|
203
215
|
* @defaultValue `[]`
|
|
204
216
|
*/
|
|
@@ -209,7 +221,7 @@ export interface Pipeline {
|
|
|
209
221
|
* task's environment, but should not contribute to the task's cache key,
|
|
210
222
|
* e.g. `AWS_SECRET_KEY`.
|
|
211
223
|
*
|
|
212
|
-
* Documentation: https://
|
|
224
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#passthroughenv
|
|
213
225
|
*
|
|
214
226
|
* @defaultValue `null`
|
|
215
227
|
*/
|
|
@@ -222,7 +234,7 @@ export interface Pipeline {
|
|
|
222
234
|
* produce no artifacts other than logs (such as linters). Logs are always treated as a
|
|
223
235
|
* cacheable artifact and never need to be specified.
|
|
224
236
|
*
|
|
225
|
-
* Documentation: https://
|
|
237
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#outputs
|
|
226
238
|
*
|
|
227
239
|
* @defaultValue `[]`
|
|
228
240
|
*/
|
|
@@ -233,7 +245,7 @@ export interface Pipeline {
|
|
|
233
245
|
*
|
|
234
246
|
* Setting cache to false is useful for long-running "watch" or development mode tasks.
|
|
235
247
|
*
|
|
236
|
-
* Documentation: https://
|
|
248
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#cache
|
|
237
249
|
*
|
|
238
250
|
* @defaultValue `true`
|
|
239
251
|
*/
|
|
@@ -250,7 +262,7 @@ export interface Pipeline {
|
|
|
250
262
|
*
|
|
251
263
|
* If omitted or empty, all files in the package are considered as inputs.
|
|
252
264
|
*
|
|
253
|
-
* Documentation: https://
|
|
265
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#inputs
|
|
254
266
|
*
|
|
255
267
|
* @defaultValue `[]`
|
|
256
268
|
*/
|
|
@@ -269,7 +281,7 @@ export interface Pipeline {
|
|
|
269
281
|
*
|
|
270
282
|
* "none": Hides all task output
|
|
271
283
|
*
|
|
272
|
-
* Documentation: https://
|
|
284
|
+
* Documentation: https://turborepo.com/docs/reference/run#--output-logs-option
|
|
273
285
|
*
|
|
274
286
|
* @defaultValue `"full"`
|
|
275
287
|
*/
|
|
@@ -280,7 +292,7 @@ export interface Pipeline {
|
|
|
280
292
|
* turbo that this is a long-running task and will ensure that other tasks
|
|
281
293
|
* cannot depend on it.
|
|
282
294
|
*
|
|
283
|
-
* Documentation: https://
|
|
295
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#persistent
|
|
284
296
|
*
|
|
285
297
|
* @defaultValue `false`
|
|
286
298
|
*/
|
|
@@ -291,7 +303,7 @@ export interface Pipeline {
|
|
|
291
303
|
* Interactive tasks must be marked with "cache": false as the input
|
|
292
304
|
* they receive from stdin can change the outcome of the task.
|
|
293
305
|
*
|
|
294
|
-
* Documentation: https://
|
|
306
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#interactive
|
|
295
307
|
*
|
|
296
308
|
* @defaultValue `false`
|
|
297
309
|
*/
|
|
@@ -304,7 +316,7 @@ export interface Pipeline {
|
|
|
304
316
|
* not be restarted by default. To enable restarting persistent tasks, set
|
|
305
317
|
* `interruptible` to true.
|
|
306
318
|
*
|
|
307
|
-
* Documentation: https://
|
|
319
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#interruptible
|
|
308
320
|
*
|
|
309
321
|
* @defaultValue `false`
|
|
310
322
|
*/
|
|
@@ -315,7 +327,7 @@ export interface Pipeline {
|
|
|
315
327
|
*
|
|
316
328
|
* Tasks in this list will not be run until completion before this task starts execution.
|
|
317
329
|
*
|
|
318
|
-
* Documentation: https://
|
|
330
|
+
* Documentation: https://turborepo.com/docs/reference/configuration#with
|
|
319
331
|
*
|
|
320
332
|
* @defaultValue `[]`
|
|
321
333
|
*/
|
|
@@ -337,7 +349,7 @@ export interface RemoteCache {
|
|
|
337
349
|
* Indicates if the remote cache is enabled. When `false`, Turborepo will disable
|
|
338
350
|
* all remote cache operations, even if the repo has a valid token. If true, remote caching
|
|
339
351
|
* is enabled, but still requires the user to login and link their repo to a remote cache.
|
|
340
|
-
* Documentation: https://
|
|
352
|
+
* Documentation: https://turborepo.com/docs/core-concepts/remote-caching
|
|
341
353
|
*
|
|
342
354
|
* @defaultValue `true`
|
|
343
355
|
*/
|
|
@@ -354,14 +366,14 @@ export interface RemoteCache {
|
|
|
354
366
|
preflight?: boolean;
|
|
355
367
|
/**
|
|
356
368
|
* Set endpoint for API calls to the remote cache.
|
|
357
|
-
* Documentation: https://
|
|
369
|
+
* Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting
|
|
358
370
|
*
|
|
359
371
|
* @defaultValue `"https://vercel.com/api"`
|
|
360
372
|
*/
|
|
361
373
|
apiUrl?: string;
|
|
362
374
|
/**
|
|
363
375
|
* Set endpoint for requesting tokens during `turbo login`.
|
|
364
|
-
* Documentation: https://
|
|
376
|
+
* Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting
|
|
365
377
|
*
|
|
366
378
|
* @defaultValue `"https://vercel.com"`
|
|
367
379
|
*/
|