@turbo/types 2.0.13 → 2.0.14

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/types/config.ts +22 -18
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@turbo/types",
3
- "version": "2.0.13",
3
+ "version": "2.0.14",
4
4
  "description": "Turborepo types",
5
5
  "homepage": "https://turbo.build/repo",
6
6
  "license": "MIT",
@@ -7,7 +7,7 @@ export type LegacySchema = LegacyRootSchema | LegacyWorkspaceSchema;
7
7
  export type SchemaV1 = RootSchemaV1 | WorkspaceSchemaV1;
8
8
 
9
9
  export interface BaseSchema {
10
- /** @defaultValue https://turbo.build/schema.json */
10
+ /** @defaultValue `https://turbo.build/schema.json` */
11
11
  $schema?: string;
12
12
  /**
13
13
  * An object representing the task dependency graph of your project. turbo interprets
@@ -49,7 +49,7 @@ export interface WorkspaceSchema extends BaseSchema {
49
49
  *
50
50
  * Currently, only the "//" value is allowed.
51
51
  *
52
- * @defaultValue ["//"]
52
+ * @defaultValue `["//"]`
53
53
  */
54
54
  extends: Array<string>;
55
55
  }
@@ -79,7 +79,7 @@ export interface RootSchema extends BaseSchema {
79
79
  *
80
80
  * Documentation: https://turbo.build/repo/docs/reference/configuration#globaldependencies
81
81
  *
82
- * @defaultValue []
82
+ * @defaultValue `[]`
83
83
  */
84
84
  globalDependencies?: Array<string>;
85
85
 
@@ -90,7 +90,7 @@ export interface RootSchema extends BaseSchema {
90
90
  *
91
91
  * Documentation: https://turbo.build/repo/docs/reference/configuration#globalenv
92
92
  *
93
- * @defaultValue []
93
+ * @defaultValue `[]`
94
94
  */
95
95
  globalEnv?: Array<EnvWildcard>;
96
96
 
@@ -100,7 +100,7 @@ export interface RootSchema extends BaseSchema {
100
100
  *
101
101
  * Documentation: https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
102
102
  *
103
- * @defaultValue null
103
+ * @defaultValue `null`
104
104
  */
105
105
  globalPassThroughEnv?: null | Array<EnvWildcard>;
106
106
 
@@ -110,7 +110,7 @@ export interface RootSchema extends BaseSchema {
110
110
  *
111
111
  * Documentation: https://turbo.build/repo/docs/reference/configuration#globalDotEnv
112
112
  *
113
- * @defaultValue null
113
+ * @defaultValue `null`
114
114
  */
115
115
  globalDotEnv?: null | Array<AnchoredUnixPath>;
116
116
 
@@ -139,6 +139,8 @@ export interface RootSchema extends BaseSchema {
139
139
  * configuration to infer the correct package manager.
140
140
  *
141
141
  * Some turbo features are disabled if this is set to true.
142
+ *
143
+ * @defaultValue `false`
142
144
  */
143
145
  dangerouslyDisablePackageManagerCheck?: boolean;
144
146
  }
@@ -162,7 +164,7 @@ export interface Pipeline {
162
164
  *
163
165
  * Documentation: https://turbo.build/repo/docs/reference/configuration#dependson
164
166
  *
165
- * @defaultValue []
167
+ * @defaultValue `[]`
166
168
  */
167
169
  dependsOn?: Array<string>;
168
170
 
@@ -176,7 +178,7 @@ export interface Pipeline {
176
178
  *
177
179
  * Documentation: https://turbo.build/repo/docs/reference/configuration#env
178
180
  *
179
- * @defaultValue []
181
+ * @defaultValue `[]`
180
182
  */
181
183
  env?: Array<EnvWildcard>;
182
184
 
@@ -187,7 +189,7 @@ export interface Pipeline {
187
189
  *
188
190
  * Documentation: https://turbo.build/repo/docs/reference/configuration#passthroughenv
189
191
  *
190
- * @defaultValue null
192
+ * @defaultValue `null`
191
193
  */
192
194
  passThroughEnv?: null | Array<EnvWildcard>;
193
195
 
@@ -197,7 +199,7 @@ export interface Pipeline {
197
199
  *
198
200
  * Documentation: https://turbo.build/repo/docs/reference/configuration#dotEnv
199
201
  *
200
- * @defaultValue null
202
+ * @defaultValue `null`
201
203
  */
202
204
  dotEnv?: null | Array<AnchoredUnixPath>;
203
205
 
@@ -210,7 +212,7 @@ export interface Pipeline {
210
212
  *
211
213
  * Documentation: https://turbo.build/repo/docs/reference/configuration#outputs
212
214
  *
213
- * @defaultValue []
215
+ * @defaultValue `[]`
214
216
  */
215
217
  outputs?: Array<string>;
216
218
 
@@ -221,7 +223,7 @@ export interface Pipeline {
221
223
  *
222
224
  * Documentation: https://turbo.build/repo/docs/reference/configuration#cache
223
225
  *
224
- * @defaultValue true
226
+ * @defaultValue `true`
225
227
  */
226
228
  cache?: boolean;
227
229
 
@@ -238,7 +240,7 @@ export interface Pipeline {
238
240
  *
239
241
  * Documentation: https://turbo.build/repo/docs/reference/configuration#inputs
240
242
  *
241
- * @defaultValue []
243
+ * @defaultValue `[]`
242
244
  */
243
245
  inputs?: Array<string>;
244
246
 
@@ -257,7 +259,7 @@ export interface Pipeline {
257
259
  *
258
260
  * Documentation: https://turbo.build/repo/docs/reference/run#--output-logs-option
259
261
  *
260
- * @defaultValue full
262
+ * @defaultValue `"full"`
261
263
  */
262
264
  outputLogs?: OutputMode;
263
265
 
@@ -268,7 +270,7 @@ export interface Pipeline {
268
270
  *
269
271
  * Documentation: https://turbo.build/repo/docs/reference/configuration#persistent
270
272
  *
271
- * @defaultValue false
273
+ * @defaultValue `false`
272
274
  */
273
275
  persistent?: boolean;
274
276
 
@@ -278,6 +280,8 @@ export interface Pipeline {
278
280
  * they receive from stdin can change the outcome of the task.
279
281
  *
280
282
  * Documentation: https://turbo.build/repo/docs/reference/configuration#interactive
283
+ *
284
+ * @defaultValue `false`
281
285
  */
282
286
  interactive?: boolean;
283
287
  }
@@ -289,7 +293,7 @@ export interface RemoteCache {
289
293
  * variable `TURBO_REMOTE_CACHE_SIGNATURE_KEY`. Turborepo will reject any downloaded artifacts
290
294
  * that have an invalid signature or are missing a signature.
291
295
  *
292
- * @defaultValue false
296
+ * @defaultValue `false`
293
297
  */
294
298
  signature?: boolean;
295
299
 
@@ -299,7 +303,7 @@ export interface RemoteCache {
299
303
  * is enabled, but still requires the user to login and link their repo to a remote cache.
300
304
  * Documentation: https://turbo.build/repo/docs/core-concepts/remote-caching
301
305
  *
302
- * @defaultValue true
306
+ * @defaultValue `true`
303
307
  */
304
308
  enabled?: boolean;
305
309
  }
@@ -310,7 +314,7 @@ export type OutputMode =
310
314
  | "new-only"
311
315
  | "errors-only"
312
316
  | "none";
313
-
317
+ export type EnvMode = "strict" | "loose";
314
318
  export type UI = "tui" | "stream";
315
319
 
316
320
  export type AnchoredUnixPath = string;