turbo 2.5.1-canary.2 → 2.5.1
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 +3 -3
- package/package.json +8 -8
- package/schema.json +26 -26
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<a href="https://
|
|
2
|
+
<a href="https://turborepo.com">
|
|
3
3
|
<picture>
|
|
4
4
|
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4060187/196936123-f6e1db90-784d-4174-b774-92502b718836.png">
|
|
5
5
|
<img src="https://user-images.githubusercontent.com/4060187/196936104-5797972c-ab10-4834-bd61-0d1e5f442c9c.png" height="128">
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
|
|
26
26
|
## Getting Started
|
|
27
27
|
|
|
28
|
-
Visit https://
|
|
28
|
+
Visit https://turborepo.com/docs to get started with Turborepo and read the documentation.
|
|
29
29
|
|
|
30
30
|
## Community
|
|
31
31
|
|
|
@@ -37,7 +37,7 @@ Our [Code of Conduct](https://github.com/vercel/turborepo/blob/main/CODE_OF_COND
|
|
|
37
37
|
|
|
38
38
|
## Who is using Turbo?
|
|
39
39
|
|
|
40
|
-
Turbo is used by the world's leading companies. Check out the [Turbo Showcase](https://
|
|
40
|
+
Turbo is used by the world's leading companies. Check out the [Turbo Showcase](https://turborepo.com/showcase) to learn more.
|
|
41
41
|
|
|
42
42
|
## Updates
|
|
43
43
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "turbo",
|
|
3
|
-
"version": "2.5.1
|
|
3
|
+
"version": "2.5.1",
|
|
4
4
|
"description": "Turborepo is a high-performance build system for JavaScript and TypeScript codebases.",
|
|
5
5
|
"repository": "https://github.com/vercel/turborepo",
|
|
6
6
|
"bugs": "https://github.com/vercel/turborepo/issues",
|
|
7
|
-
"homepage": "https://
|
|
7
|
+
"homepage": "https://turborepo.com",
|
|
8
8
|
"license": "MIT",
|
|
9
9
|
"main": "./bin/turbo",
|
|
10
10
|
"bin": {
|
|
@@ -15,12 +15,12 @@
|
|
|
15
15
|
"schema.json"
|
|
16
16
|
],
|
|
17
17
|
"optionalDependencies": {
|
|
18
|
-
"turbo-darwin-64": "2.5.1
|
|
19
|
-
"turbo-darwin-arm64": "2.5.1
|
|
20
|
-
"turbo-linux-64": "2.5.1
|
|
21
|
-
"turbo-linux-arm64": "2.5.1
|
|
22
|
-
"turbo-windows-64": "2.5.1
|
|
23
|
-
"turbo-windows-arm64": "2.5.1
|
|
18
|
+
"turbo-darwin-64": "2.5.1",
|
|
19
|
+
"turbo-darwin-arm64": "2.5.1",
|
|
20
|
+
"turbo-linux-64": "2.5.1",
|
|
21
|
+
"turbo-linux-arm64": "2.5.1",
|
|
22
|
+
"turbo-windows-64": "2.5.1",
|
|
23
|
+
"turbo-windows-arm64": "2.5.1"
|
|
24
24
|
},
|
|
25
25
|
"scripts": {
|
|
26
26
|
"postversion": "node bump-version.js"
|
package/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,17 +56,17 @@
|
|
|
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
72
|
"dangerouslyDisablePackageManagerCheck": {
|
|
@@ -76,17 +76,17 @@
|
|
|
76
76
|
},
|
|
77
77
|
"cacheDir": {
|
|
78
78
|
"$ref": "#/definitions/RelativeUnixPath",
|
|
79
|
-
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://
|
|
79
|
+
"description": "Specify the filesystem cache directory.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#cachedir",
|
|
80
80
|
"default": ".turbo/cache"
|
|
81
81
|
},
|
|
82
82
|
"daemon": {
|
|
83
83
|
"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://
|
|
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://turborepo.com/docs/reference/configuration#daemon",
|
|
85
85
|
"default": false
|
|
86
86
|
},
|
|
87
87
|
"envMode": {
|
|
88
88
|
"$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://
|
|
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://turborepo.com/docs/reference/configuration#envmode",
|
|
90
90
|
"default": "strict"
|
|
91
91
|
},
|
|
92
92
|
"boundaries": {
|
|
@@ -107,7 +107,7 @@
|
|
|
107
107
|
"items": {
|
|
108
108
|
"type": "string"
|
|
109
109
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#dependson",
|
|
111
111
|
"default": []
|
|
112
112
|
},
|
|
113
113
|
"env": {
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
"items": {
|
|
116
116
|
"$ref": "#/definitions/EnvWildcard"
|
|
117
117
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#env",
|
|
119
119
|
"default": []
|
|
120
120
|
},
|
|
121
121
|
"passThroughEnv": {
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
}
|
|
131
131
|
}
|
|
132
132
|
],
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#passthroughenv",
|
|
134
134
|
"default": null
|
|
135
135
|
},
|
|
136
136
|
"outputs": {
|
|
@@ -138,12 +138,12 @@
|
|
|
138
138
|
"items": {
|
|
139
139
|
"type": "string"
|
|
140
140
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#outputs",
|
|
142
142
|
"default": []
|
|
143
143
|
},
|
|
144
144
|
"cache": {
|
|
145
145
|
"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://
|
|
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://turborepo.com/docs/reference/configuration#cache",
|
|
147
147
|
"default": true
|
|
148
148
|
},
|
|
149
149
|
"inputs": {
|
|
@@ -151,27 +151,27 @@
|
|
|
151
151
|
"items": {
|
|
152
152
|
"type": "string"
|
|
153
153
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#inputs",
|
|
155
155
|
"default": []
|
|
156
156
|
},
|
|
157
157
|
"outputLogs": {
|
|
158
158
|
"$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://
|
|
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://turborepo.com/docs/reference/run#--output-logs-option",
|
|
160
160
|
"default": "full"
|
|
161
161
|
},
|
|
162
162
|
"persistent": {
|
|
163
163
|
"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://
|
|
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://turborepo.com/docs/reference/configuration#persistent",
|
|
165
165
|
"default": false
|
|
166
166
|
},
|
|
167
167
|
"interactive": {
|
|
168
168
|
"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://
|
|
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://turborepo.com/docs/reference/configuration#interactive",
|
|
170
170
|
"default": false
|
|
171
171
|
},
|
|
172
172
|
"interruptible": {
|
|
173
173
|
"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://
|
|
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://turborepo.com/docs/reference/configuration#interruptible",
|
|
175
175
|
"default": false
|
|
176
176
|
},
|
|
177
177
|
"with": {
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
"items": {
|
|
180
180
|
"type": "string"
|
|
181
181
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#with",
|
|
183
183
|
"default": []
|
|
184
184
|
}
|
|
185
185
|
},
|
|
@@ -208,7 +208,7 @@
|
|
|
208
208
|
},
|
|
209
209
|
"enabled": {
|
|
210
210
|
"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://
|
|
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://turborepo.com/docs/core-concepts/remote-caching",
|
|
212
212
|
"default": true
|
|
213
213
|
},
|
|
214
214
|
"preflight": {
|
|
@@ -218,12 +218,12 @@
|
|
|
218
218
|
},
|
|
219
219
|
"apiUrl": {
|
|
220
220
|
"type": "string",
|
|
221
|
-
"description": "Set endpoint for API calls to the remote cache. Documentation: https://
|
|
221
|
+
"description": "Set endpoint for API calls to the remote cache. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
222
222
|
"default": "https://vercel.com/api"
|
|
223
223
|
},
|
|
224
224
|
"loginUrl": {
|
|
225
225
|
"type": "string",
|
|
226
|
-
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://
|
|
226
|
+
"description": "Set endpoint for requesting tokens during `turbo login`. Documentation: https://turborepo.com/docs/core-concepts/remote-caching#self-hosting",
|
|
227
227
|
"default": "https://vercel.com"
|
|
228
228
|
},
|
|
229
229
|
"timeout": {
|
|
@@ -324,7 +324,7 @@
|
|
|
324
324
|
"properties": {
|
|
325
325
|
"$schema": {
|
|
326
326
|
"type": "string",
|
|
327
|
-
"default": "https://
|
|
327
|
+
"default": "https://turborepo.com/schema.v2.json"
|
|
328
328
|
},
|
|
329
329
|
"tasks": {
|
|
330
330
|
"type": "object",
|
|
@@ -332,7 +332,7 @@
|
|
|
332
332
|
"$ref": "#/definitions/Pipeline",
|
|
333
333
|
"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
334
|
},
|
|
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://
|
|
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://turborepo.com/docs/reference/configuration#tasks",
|
|
336
336
|
"default": {}
|
|
337
337
|
},
|
|
338
338
|
"extends": {
|