chore(core): change enableDbCache to useLegacyCache

nrwl · Oct 3, 2024 · 7c600f1 · 7c600f1
1 parent 5dd58f9
commit 7c600f1
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 26 deletions.
diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -23,7 +23,6 @@ Nx.json configuration
 - [cli](../../devkit/documents/NxJsonConfiguration#cli): Object
 - [defaultBase](../../devkit/documents/NxJsonConfiguration#defaultbase): string
 - [defaultProject](../../devkit/documents/NxJsonConfiguration#defaultproject): string
-- [enableDbCache](../../devkit/documents/NxJsonConfiguration#enabledbcache): boolean
 - [extends](../../devkit/documents/NxJsonConfiguration#extends): string
 - [generators](../../devkit/documents/NxJsonConfiguration#generators): Object
 - [implicitDependencies](../../devkit/documents/NxJsonConfiguration#implicitdependencies): ImplicitDependencyEntry<T>
@@ -43,6 +42,7 @@ Nx.json configuration
 - [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
 - [useDaemonProcess](../../devkit/documents/NxJsonConfiguration#usedaemonprocess): boolean
 - [useInferencePlugins](../../devkit/documents/NxJsonConfiguration#useinferenceplugins): boolean
+- [useLegacyCache](../../devkit/documents/NxJsonConfiguration#uselegacycache): boolean
 - [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object
 
 ## Properties
@@ -99,14 +99,6 @@ will be used. Convenient for small workspaces with one main application.
 
 ---
 
-### enableDbCache
-
-• `Optional` **enableDbCache**: `boolean`
-
-Enable the new experimental db based cache
-
----
-
 ### extends
 
 • `Optional` **extends**: `string`
@@ -297,6 +289,14 @@ Set this to false to disable adding inference plugins when generating new projec
 
 ---
 
+### useLegacyCache
+
+• `Optional` **useLegacyCache**: `boolean`
+
+Use the legacy file system cache instead of the db cache
+
+---
+
 ### workspaceLayout
 
 • `Optional` **workspaceLayout**: `Object`

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -21,7 +21,6 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [cli](../../devkit/documents/Workspace#cli): Object
 - [defaultBase](../../devkit/documents/Workspace#defaultbase): string
 - [defaultProject](../../devkit/documents/Workspace#defaultproject): string
-- [enableDbCache](../../devkit/documents/Workspace#enabledbcache): boolean
 - [extends](../../devkit/documents/Workspace#extends): string
 - [generators](../../devkit/documents/Workspace#generators): Object
 - [implicitDependencies](../../devkit/documents/Workspace#implicitdependencies): ImplicitDependencyEntry<string[] | "\*">
@@ -42,6 +41,7 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
 - [useDaemonProcess](../../devkit/documents/Workspace#usedaemonprocess): boolean
 - [useInferencePlugins](../../devkit/documents/Workspace#useinferenceplugins): boolean
+- [useLegacyCache](../../devkit/documents/Workspace#uselegacycache): boolean
 - [version](../../devkit/documents/Workspace#version): number
 - [workspaceLayout](../../devkit/documents/Workspace#workspacelayout): Object
 
@@ -119,18 +119,6 @@ will be used. Convenient for small workspaces with one main application.
 
 ---
 
-### enableDbCache
-
-• `Optional` **enableDbCache**: `boolean`
-
-Enable the new experimental db based cache
-
-#### Inherited from
-
-[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[enableDbCache](../../devkit/documents/NxJsonConfiguration#enabledbcache)
-
----
-
 ### extends
 
 • `Optional` **extends**: `string`
@@ -409,6 +397,18 @@ Set this to false to disable adding inference plugins when generating new projec
 
 ---
 
+### useLegacyCache
+
+• `Optional` **useLegacyCache**: `boolean`
+
+Use the legacy file system cache instead of the db cache
+
+#### Inherited from
+
+[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[useLegacyCache](../../devkit/documents/NxJsonConfiguration#uselegacycache)
+
+---
+
 ### version
 
 • **version**: `number`

diff --git a/packages/nx/src/adapter/compat.ts b/packages/nx/src/adapter/compat.ts
@@ -80,7 +80,7 @@ export const allowedWorkspaceExtensions = [
   'useInferencePlugins',
   'neverConnectToCloud',
   'sync',
-  'enableDbCache',
+  'useLegacyCache',
 ] as const;
 
 if (!patched) {

diff --git a/packages/nx/src/config/nx-json.ts b/packages/nx/src/config/nx-json.ts
@@ -517,9 +517,9 @@ export interface NxJsonConfiguration<T = '*' | string[]> {
   sync?: NxSyncConfiguration;
 
   /**
-   * Enable the new experimental db based cache
+   * Use the legacy file system cache instead of the db cache
    */
-  enableDbCache?: boolean;
+  useLegacyCache?: boolean;
 }
 
 export type PluginConfiguration = string | ExpandedPluginConfiguration;

diff --git a/packages/nx/src/tasks-runner/cache.ts b/packages/nx/src/tasks-runner/cache.ts
@@ -32,7 +32,8 @@ export type TaskWithCachedResult = { task: Task; cachedResult: CachedResult };
 export function dbCacheEnabled(nxJson: NxJsonConfiguration = readNxJson()) {
   return (
     process.env.NX_DISABLE_DB !== 'true' &&
-    (nxJson.enableDbCache === true || process.env.NX_DB_CACHE === 'true')
+    nxJson.useLegacyCache !== true &&
+    process.env.NX_DB_CACHE !== 'false'
   );
 }