feat(core): allow specifying cacheability per target

nrwl · Oct 17, 2023 · 992cbaf · 992cbaf
1 parent 81e8d12
commit 992cbaf
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 16 deletions.
diff --git a/docs/generated/devkit/TargetConfiguration.md b/docs/generated/devkit/TargetConfiguration.md
@@ -12,6 +12,7 @@ Target's configuration
 
 ### Properties
 
+- [cache](../../devkit/documents/TargetConfiguration#cache): boolean
 - [command](../../devkit/documents/TargetConfiguration#command): string
 - [configurations](../../devkit/documents/TargetConfiguration#configurations): Object
 - [defaultConfiguration](../../devkit/documents/TargetConfiguration#defaultconfiguration): string
@@ -23,6 +24,14 @@ Target's configuration
 
 ## Properties
 
+### cache
+
+• `Optional` **cache**: `boolean`
+
+Determines if Nx is able to cache a given target.
+
+---
+
 ### command
 
 • `Optional` **command**: `string`

diff --git a/docs/generated/devkit/TargetDefaults.md b/docs/generated/devkit/TargetDefaults.md
@@ -1,3 +1,3 @@
 # Type alias: TargetDefaults
 
-Ƭ **TargetDefaults**: `Record`<`string`, `Partial`<[`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\> & { `cache?`: `boolean` }\>
+Ƭ **TargetDefaults**: `Record`<`string`, `Partial`<[`TargetConfiguration`](../../devkit/documents/TargetConfiguration)\>\>
diff --git a/packages/nx/schemas/project-schema.json b/packages/nx/schemas/project-schema.json
@@ -108,6 +108,10 @@
           "command": {
             "type": "string",
             "description": "A shorthand for using the nx:run-commands executor"
+          },
+          "cache": {
+            "type": "boolean",
+            "description": "Specifies if the given target should be cacheable"
           }
         }
       }

diff --git a/packages/nx/schemas/workspace-schema.json b/packages/nx/schemas/workspace-schema.json
@@ -118,6 +118,10 @@
                           "command": {
                             "type": "string",
                             "description": "A shorthand for using the nx:run-commands executor"
+                          },
+                          "cache": {
+                            "type": "boolean",
+                            "description": "Specifies if the given target should be cacheable"
                           }
                         }
                       }

diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -25,16 +25,7 @@ export interface NxAffectedConfig {
   defaultBase?: string;
 }
 
-export type TargetDefaults = Record<
-  string,
-  Partial<TargetConfiguration> & {
-    /**
-     * Determines if Nx is able to cache a given target.
-     * Currently only supported in `targetDefaults`.
-     */
-    cache?: boolean;
-  }
->;
+export type TargetDefaults = Record<string, Partial<TargetConfiguration>>;
 
 export type TargetDependencies = Record<
   string,

diff --git a/packages/nx/src/config/workspace-json-project-json.ts b/packages/nx/src/config/workspace-json-project-json.ts
@@ -181,4 +181,9 @@ export interface TargetConfiguration<T = any> {
    * A default named configuration to use when a target configuration is not provided.
    */
   defaultConfiguration?: string;
+
+  /**
+   * Determines if Nx is able to cache a given target.
+   */
+  cache?: boolean;
 }
diff --git a/packages/nx/src/tasks-runner/utils.ts b/packages/nx/src/tasks-runner/utils.ts
@@ -352,11 +352,7 @@ export function isCacheableTask(
     cacheableTargets?: string[] | null;
   }
 ): boolean {
-  if (
-    task.cache !== undefined &&
-    process.env.NX_ALLOW_PROJECT_LEVEL_CACHE === 'true' &&
-    !longRunningTask(task)
-  ) {
+  if (task.cache !== undefined && !longRunningTask(task)) {
     return task.cache;
   }