@turbo/types 2.0.13 → 2.0.15-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbo/types",
-  "version": "2.0.13",
+  "version": "2.0.15-canary.0",
   "description": "Turborepo types",
   "homepage": "https://turbo.build/repo",
   "license": "MIT",

package/src/types/config.ts

@@ -7,7 +7,7 @@ export type LegacySchema = LegacyRootSchema | LegacyWorkspaceSchema;
 export type SchemaV1 = RootSchemaV1 | WorkspaceSchemaV1;
 
 export interface BaseSchema {
-  /** @defaultValue https://turbo.build/schema.json */
+  /** @defaultValue `https://turbo.build/schema.json` */
   $schema?: string;
   /**
    * An object representing the task dependency graph of your project. turbo interprets
@@ -49,7 +49,7 @@ export interface WorkspaceSchema extends BaseSchema {
    *
    * Currently, only the "//" value is allowed.
    *
-   * @defaultValue ["//"]
+   * @defaultValue `["//"]`
    */
   extends: Array<string>;
 }
@@ -79,7 +79,7 @@ export interface RootSchema extends BaseSchema {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#globaldependencies
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   globalDependencies?: Array<string>;
 
@@ -90,7 +90,7 @@ export interface RootSchema extends BaseSchema {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#globalenv
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   globalEnv?: Array<EnvWildcard>;
 
@@ -100,17 +100,17 @@ export interface RootSchema extends BaseSchema {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
    *
-   * @defaultValue null
+   * @defaultValue `null`
    */
   globalPassThroughEnv?: null | Array<EnvWildcard>;
 
   /**
+   * @deprecated as of Turborepo 2.0.0. Consider using {@link RootSchema.globalDependencies} instead.
+   *
    * A priority-ordered (most-significant to least-significant) array of project-anchored
    * Unix-style paths to `.env` files to include in the global hash.
    *
-   * Documentation: https://turbo.build/repo/docs/reference/configuration#globalDotEnv
-   *
-   * @defaultValue null
+   * @defaultValue `null`
    */
   globalDotEnv?: null | Array<AnchoredUnixPath>;
 
@@ -139,8 +139,40 @@ export interface RootSchema extends BaseSchema {
    * configuration to infer the correct package manager.
    *
    * Some turbo features are disabled if this is set to true.
+   *
+   * @defaultValue `false`
    */
   dangerouslyDisablePackageManagerCheck?: boolean;
+
+  /**
+   * Specify the filesystem cache directory.
+   *
+   * Documentation: https://turbo.build/repo/docs/reference/configuration#tasks
+   *
+   * @defaultValue `"".turbo/cache"`
+   */
+  cacheDir?: RelativeUnixPath;
+
+  /**
+   * Turbo can run a background process to pre-calculate values used for determining work that needs to be done. This standalone process (daemon) is an optimization, and not required for proper functioning of turbo.
+   *
+   * Documentation: https://turbo.build/repo/docs/reference/configuration#daemon
+   *
+   * @defaultValue `false`
+   */
+  daemon?: boolean;
+
+  /**
+   * Turborepo's Environment Modes allow you to control which environment variables are available to a task at runtime:
+   *
+   * - **Strict Mode**: Filter environment variables to only those that are specified in the `env` and `globalEnv` keys in `turbo.json`.
+   * - **Loose Mode**: Allow all environment variables for the process to be available.
+   *
+   * Documentation: https://turbo.build/repo/docs/crafting-your-repository/using-environment-variables#environment-modes
+   *
+   * @defaultValue `"strict"`
+   */
+  envMode?: EnvMode;
 }
 
 export type LegacyRootSchema = RootSchema & LegacyBaseSchema;
@@ -162,7 +194,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#dependson
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   dependsOn?: Array<string>;
 
@@ -176,7 +208,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#env
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   env?: Array<EnvWildcard>;
 
@@ -187,17 +219,17 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#passthroughenv
    *
-   * @defaultValue null
+   * @defaultValue `null`
    */
   passThroughEnv?: null | Array<EnvWildcard>;
 
   /**
+   * @deprecated as of Turborepo 2.0.0. Consider using {@link Pipeline.inputs} instead.
+   *
    * A priority-ordered (most-significant to least-significant) array of workspace-anchored
    * Unix-style paths to `.env` files to include in the task hash.
    *
-   * Documentation: https://turbo.build/repo/docs/reference/configuration#dotEnv
-   *
-   * @defaultValue null
+   * @defaultValue `null`
    */
   dotEnv?: null | Array<AnchoredUnixPath>;
 
@@ -210,7 +242,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#outputs
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   outputs?: Array<string>;
 
@@ -221,7 +253,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#cache
    *
-   * @defaultValue true
+   * @defaultValue `true`
    */
   cache?: boolean;
 
@@ -238,7 +270,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#inputs
    *
-   * @defaultValue []
+   * @defaultValue `[]`
    */
   inputs?: Array<string>;
 
@@ -257,7 +289,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/run#--output-logs-option
    *
-   * @defaultValue full
+   * @defaultValue `"full"`
    */
   outputLogs?: OutputMode;
 
@@ -268,7 +300,7 @@ export interface Pipeline {
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#persistent
    *
-   * @defaultValue false
+   * @defaultValue `false`
    */
   persistent?: boolean;
 
@@ -278,6 +310,8 @@ export interface Pipeline {
    * they receive from stdin can change the outcome of the task.
    *
    * Documentation: https://turbo.build/repo/docs/reference/configuration#interactive
+   *
+   * @defaultValue `false`
    */
   interactive?: boolean;
 }
@@ -289,7 +323,7 @@ export interface RemoteCache {
    * variable `TURBO_REMOTE_CACHE_SIGNATURE_KEY`. Turborepo will reject any downloaded artifacts
    * that have an invalid signature or are missing a signature.
    *
-   * @defaultValue false
+   * @defaultValue `false`
    */
   signature?: boolean;
 
@@ -299,7 +333,7 @@ export interface RemoteCache {
    * is enabled, but still requires the user to login and link their repo to a remote cache.
    * Documentation: https://turbo.build/repo/docs/core-concepts/remote-caching
    *
-   * @defaultValue true
+   * @defaultValue `true`
    */
   enabled?: boolean;
 }
@@ -310,8 +344,12 @@ export type OutputMode =
   | "new-only"
   | "errors-only"
   | "none";
-
+export type EnvMode = "strict" | "loose";
 export type UI = "tui" | "stream";
 
+/**
+ * This is a relative Unix-style path (e.g. `./src/index.ts` or `src/index.ts`).  Absolute paths (e.g. `/tmp/foo`) are not valid.
+ */
+export type RelativeUnixPath = string;
 export type AnchoredUnixPath = string;
 export type EnvWildcard = string;