[READ-ONLY] Mirror of https://github.com/vitest-dev/vitest. Next generation testing framework powered by Vite.
vitest.dev
test
testing-tools
vite
docs: replace `reference types="vitest"` with vitest/config (#6325)
+37
-14
+13
docs/config/file.md
+13
docs/config/file.md
···
25
25
})
26
26
```
27
27
28
+
The `<reference types="vitest" />` will stop working in Vitest 3, but you can start migrating to `vitest/config` in Vitest 2.1:
29
+
30
+
```ts
31
+
/// <reference types="vitest/config" />
32
+
import { defineConfig } from 'vite'
33
+
34
+
export default defineConfig({
35
+
test: {
36
+
// ... Specify options here.
37
+
},
38
+
})
39
+
```
40
+
28
41
Using `defineConfig` from `vitest/config` you should follow this:
29
42
30
43
```ts
+4
-6
docs/guide/in-source.md
+4
-6
docs/guide/in-source.md
···
34
34
Update the `includeSource` config for Vitest to grab the files under `src/`:
35
35
36
36
```ts
37
-
// vite.config.ts
38
-
/// <reference types="vitest" />
39
-
import { defineConfig } from 'vite'
37
+
// vitest.config.ts
38
+
import { defineConfig } from 'vitest/config'
40
39
41
40
export default defineConfig({
42
41
test: {
···
56
55
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
57
56
58
57
```ts
59
-
// vite.config.ts
60
-
/// <reference types="vitest" />
61
-
import { defineConfig } from 'vite'
58
+
// vitest.config.ts
59
+
import { defineConfig } from 'vitest/config'
62
60
63
61
export default defineConfig({
64
62
test: {
+13
docs/guide/index.md
+13
docs/guide/index.md
···
133
133
})
134
134
```
135
135
136
+
The `<reference types="vitest" />` will stop working in Vitest 3, but you can start migrating to `vitest/config` in Vitest 2.1:
137
+
138
+
```ts
139
+
/// <reference types="vitest/config" />
140
+
import { defineConfig } from 'vite'
141
+
142
+
export default defineConfig({
143
+
test: {
144
+
// ... Specify options here.
145
+
},
146
+
})
147
+
```
148
+
136
149
See the list of config options in the [Config Reference](../config/)
137
150
138
151
::: warning
+1
-2
docs/guide/reporters.md
+1
-2
docs/guide/reporters.md
+1
-1
examples/basic/vite.config.ts
+1
-1
examples/basic/vite.config.ts
+1
-1
examples/lit/vite.config.ts
+1
-1
examples/lit/vite.config.ts
+1
-1
examples/preact/vite.config.ts
+1
-1
examples/preact/vite.config.ts
+1
-1
examples/react/vitest.config.ts
+1
-1
examples/react/vitest.config.ts
+1
-1
examples/solid/vite.config.mjs
+1
-1
examples/solid/vite.config.mjs