docs: replace reference types="vitest" with vitest/config (#6325)

Author: sheremet-va

docs/config/file.md

@@ -25,6 +25,19 @@ export default defineConfig({
 })
 ```
 
+The `<reference types="vitest" />` will stop working in Vitest 3, but you can start migrating to `vitest/config` in Vitest 2.1:
+
+```ts
+/// <reference types="vitest/config" />
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    // ... Specify options here.
+  },
+})
+```
+
 Using `defineConfig` from `vitest/config` you should follow this:
 
 ```ts

docs/guide/in-source.md

@@ -34,9 +34,8 @@ if (import.meta.vitest) {
 Update the `includeSource` config for Vitest to grab the files under `src/`:
 
 ```ts
-// vite.config.ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
   test: {
@@ -56,9 +55,8 @@ $ npx vitest
 For the production build, you will need to set the `define` options in your config file, letting the bundler do the dead code elimination. For example, in Vite
 
 ```ts
-// vite.config.ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
   test: {

docs/guide/index.md

@@ -133,6 +133,19 @@ export default defineConfig({
 })
 ```
 
+The `<reference types="vitest" />` will stop working in Vitest 3, but you can start migrating to `vitest/config` in Vitest 2.1:
+
+```ts
+/// <reference types="vitest/config" />
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    // ... Specify options here.
+  },
+})
+```
+
 See the list of config options in the [Config Reference](../config/)
 
 ::: warning

docs/guide/reporters.md

@@ -16,8 +16,7 @@ npx vitest --reporter=verbose
 Using reporters via [`vitest.config.ts`](/config/):
 
 ```ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
+import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
   test: {

examples/basic/vite.config.ts

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 
 // Configure Vitest (https://vitest.dev/config/)
 

examples/lit/vite.config.ts

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 
 import { defineConfig } from 'vite'
 

examples/preact/vite.config.ts

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 /// <reference types="vite/client" />
 
 import { defineConfig } from 'vite'

examples/react/vitest.config.ts

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 
 import { defineConfig } from 'vite'
 

examples/solid/vite.config.mjs

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 /// <reference types="vite/client" />
 
 import { defineConfig } from 'vite'

examples/typecheck/vite.config.ts

@@ -1,4 +1,4 @@
-/// <reference types="vitest" />
+/// <reference types="vitest/config" />
 
 // Configure Vitest (https://vitest.dev/config/)