feat(config): deprecate cache.dir option

docs/config/index.md

@@ -1732,18 +1732,10 @@ Test above this limit will be queued to run when available slot appears.
 
 ### cache<NonProjectOption />
 
-- **Type**: `false | { dir? }`
+- **Type**: `false`
 - **CLI**: `--no-cache`, `--cache=false`
 
-Options to configure Vitest cache policy. At the moment Vitest stores cache for test results to run the longer and failed tests first.
-
-#### cache.dir
-
-- **Type**: `string`
-- **Default**: `node_modules/.vitest`
-- **CLI**: `--cache.dir=./cache`
-
-Path to cache directory.
+Use this option if you want to disable the cache feature. At the moment Vitest stores cache file in Vite's [cacheDir](https://vitejs.dev/config/shared-options.html#cachedir) for test results to run the longer and failed tests first.
 
 ### sequence
 

packages/vitest/src/node/cache/index.ts

@@ -5,7 +5,6 @@ import { resolve } from 'pathe'
 import { loadConfigFromFile } from 'vite'
 import { configFiles } from '../../constants'
 import type { CliOptions } from '../cli/cli-api'
-import { slash } from '../../utils'
 import { FilesStatsCache } from './files'
 import { ResultsCache } from './results'
 
@@ -21,11 +20,10 @@ export class VitestCache {
     return this.stats.getStats(key)
   }
 
-  static resolveCacheDir(root: string, dir: string | undefined, projectName: string | undefined) {
-    const baseDir = slash(dir || 'node_modules/.vitest')
+  static resolveCacheDir(dir: string, projectName: string | undefined) {
     return projectName
-      ? resolve(root, baseDir, crypto.createHash('md5').update(projectName, 'utf-8').digest('hex'))
-      : resolve(root, baseDir)
+      ? resolve(dir, crypto.createHash('md5').update(projectName, 'utf-8').digest('hex'))
+      : dir
   }
 
   static async clearCache(options: CliOptions) {
@@ -47,7 +45,7 @@ export class VitestCache {
     if (cache === false)
       throw new Error('Cache is disabled')
 
-    const cachePath = VitestCache.resolveCacheDir(root, cache?.dir, projectName)
+    const cachePath = VitestCache.resolveCacheDir(config!.cacheDir!, projectName)
 
     let cleared = false
 

packages/vitest/src/node/cli/cli-config.ts

@@ -539,11 +539,7 @@ export const cliOptionsConfig: VitestCLIOptions = {
     description: 'Enable cache',
     argument: '', // allow only boolean
     subcommands: {
-      dir: {
-        description: 'Path to the cache directory',
-        argument: '<path>',
-        normalize: true,
-      },
+      dir: null,
     },
     // cache can only be "false" or an object
     transform(cache) {

packages/vitest/src/node/config.ts

@@ -7,11 +7,11 @@ import { defaultBrowserPort, defaultPort, extraInlineDeps } from '../constants'
 import { benchmarkConfigDefaults, configDefaults } from '../defaults'
 import { isCI, stdProvider, toArray } from '../utils'
 import type { BuiltinPool } from '../types/pool-options'
-import { VitestCache } from './cache'
 import { BaseSequencer } from './sequencers/BaseSequencer'
 import { RandomSequencer } from './sequencers/RandomSequencer'
 import type { BenchmarkBuiltinReporters } from './reporters'
 import { builtinPools } from './pool'
+import { VitestCache } from './cache'
 
 function resolvePath(path: string, root: string) {
   return normalize(
@@ -436,9 +436,17 @@ export function resolveConfig(
     resolved.css.modules.classNameStrategy ??= 'stable'
   }
 
-  resolved.cache ??= { dir: '' }
-  if (resolved.cache)
-    resolved.cache.dir = VitestCache.resolveCacheDir(resolved.root, resolved.cache.dir, resolved.name)
+  if (resolved.cache !== false) {
+    if (resolved.cache && resolved.cache.dir) {
+      console.warn(
+        c.yellow(
+        `${c.inverse(c.yellow(' Vitest '))} "cache.dir" is deprecated. Use vite's "cacheDir" instead.`,
+        ),
+      )
+    }
+
+    resolved.cache = { dir: VitestCache.resolveCacheDir(viteConfig.cacheDir, resolved.name) }
+  }
 
   resolved.sequence ??= {} as any
   if (!resolved.sequence?.sequencer) {

packages/vitest/src/node/plugins/utils.ts

@@ -2,7 +2,6 @@ import { searchForWorkspaceRoot, version as viteVersion } from 'vite'
 import type { DepOptimizationOptions, ResolvedConfig, UserConfig as ViteConfig } from 'vite'
 import { dirname } from 'pathe'
 import type { DepsOptimizationOptions, InlineConfig } from '../../types'
-import { VitestCache } from '../cache'
 import { rootDir } from '../../paths'
 
 export function resolveOptimizerConfig(_testOptions: DepsOptimizationOptions | undefined, viteOptions: DepOptimizationOptions | undefined, testConfig: InlineConfig) {
@@ -24,8 +23,6 @@ export function resolveOptimizerConfig(_testOptions: DepsOptimizationOptions | u
     }
   }
   else {
-    const root = testConfig.root ?? process.cwd()
-    const cacheDir = testConfig.cache !== false ? testConfig.cache?.dir : undefined
     const currentInclude = (testOptions.include || viteOptions?.include || [])
     const exclude = [
       'vitest',
@@ -39,7 +36,7 @@ export function resolveOptimizerConfig(_testOptions: DepsOptimizationOptions | u
 
     const include = (testOptions.include || viteOptions?.include || []).filter((n: string) => !exclude.includes(n))
 
-    newConfig.cacheDir = cacheDir ?? VitestCache.resolveCacheDir(root, cacheDir, testConfig.name)
+    newConfig.cacheDir = testConfig.cache !== false ? testConfig.cache?.dir : undefined
     newConfig.optimizeDeps = {
       ...viteOptions,
       ...testOptions,

packages/vitest/src/types/config.ts

@@ -612,10 +612,13 @@ export interface InlineConfig {
 
   /**
    * Options for configuring cache policy.
-   * @default { dir: 'node_modules/.vitest' }
+   * @default { dir: 'node_modules/.vite' }
    */
   cache?: false | {
-    dir?: string
+    /**
+     * @deprecated Use Vite's `cacheDir` instead.
+     */
+    dir: string
   }
 
   /**
@@ -830,6 +833,9 @@ export interface ResolvedConfig extends Omit<Required<UserConfig>, 'config' | 'f
   }
 
   cache: {
+    /**
+     * @deprecated
+     */
     dir: string
   } | false
 

test/cache/vitest-custom.config.ts

@@ -1,9 +1,6 @@
 import { defineConfig } from 'vite'
 
 export default defineConfig({
-  test: {
-    cache: {
-      dir: 'cache/.vitest-custom',
-    },
-  },
+  cacheDir: 'cache/.vitest-custom',
+  test: {},
 })

test/cache/vitest.config.ts

@@ -1,10 +1,8 @@
 import { defineConfig } from 'vite'
 
 export default defineConfig({
+  cacheDir: 'cache/.vitest-base',
   test: {
     pool: 'forks',
-    cache: {
-      dir: 'cache/.vitest-base',
-    },
   },
 })

test/core/test/cli-test.test.ts

@@ -212,13 +212,7 @@ test('cache is parsed correctly', () => {
   expect(getCLIOptions('--cache')).toEqual({ cache: {} })
   expect(getCLIOptions('--no-cache')).toEqual({ cache: false })
 
-  expect(getCLIOptions('--cache.dir=./test/cache.json')).toEqual({
-    cache: { dir: 'test/cache.json' },
-  })
-  expect(getCLIOptions('--cache.dir ./test/cache.json')).toEqual({
-    cache: { dir: 'test/cache.json' },
-  })
-  expect(getCLIOptions('--cache.dir .\\test\\cache.json')).toEqual({
+  expect(getCLIOptions('--cache.dir=./test/cache.json')).not.toEqual({
     cache: { dir: 'test/cache.json' },
   })
 })

test/optimize-deps/test/ssr.test.ts

@@ -8,5 +8,5 @@ import { importMetaUrl } from '@vitest/test-dep-url'
 // TODO: flaky on Windows
 // https://github.com/vitest-dev/vitest/pull/5215#discussion_r1492066033
 test.skipIf(process.platform === 'win32')('import.meta.url', () => {
-  expect(importMetaUrl).toContain('/node_modules/.vitest/deps_ssr/')
+  expect(importMetaUrl).toContain('/node_modules/.vite/deps_ssr/')
 })

test/optimize-deps/test/web.test.ts

@@ -6,5 +6,5 @@ import { expect, test } from 'vitest'
 import { importMetaUrl } from '@vitest/test-dep-url'
 
 test('import.meta.url', () => {
-  expect(importMetaUrl).toContain('/node_modules/.vitest/deps/')
+  expect(importMetaUrl).toContain('/node_modules/.vite/deps/')
 })