Skip to content

Commit cce44d7

Browse files
authored
Update GettingStarted.md with current Vite related information (#15122)
1 parent 3072501 commit cce44d7

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/GettingStarted.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,21 @@ module.exports = {
119119

120120
</details>
121121

122+
## Using with bundlers
123+
124+
Most of the time you do not need to do anything special to work with different bundlers - the exception is if you have some plugin or configuration which generates files or have custom file resolution rules.
125+
122126
### Using webpack
123127

124128
Jest can be used in projects that use [webpack](https://webpack.js.org/) to manage assets, styles, and compilation. webpack does offer some unique challenges over other tools. Refer to the [webpack guide](Webpack.md) to get started.
125129

126130
### Using Vite
127131

128-
Jest can be used in projects that use [vite](https://vitejs.dev/) to serve source code over native ESM to provide some frontend tooling, vite is an opinionated tool and does offer some out-of-the box workflows. Jest is not fully supported by vite due to how the [plugin system](https://github.com/vitejs/vite/issues/1955#issuecomment-776009094) from vite works, but there are some working examples for first-class jest integration using `vite-jest`, since this is not fully supported, you might as well read the [limitation of the `vite-jest`](https://github.com/sodatea/vite-jest/tree/main/packages/vite-jest#limitations-and-differences-with-commonjs-tests). Refer to the [vite guide](https://vitejs.dev/guide/) to get started.
132+
Jest is not supported by Vite due to incompatibilities with the Vite [plugin system](https://github.com/vitejs/vite/issues/1955#issuecomment-776009094).
133+
134+
There are examples for Jest integration with Vite in the [vite-jest](https://github.com/sodatea/vite-jest) library. However, this library is not compatible with versions of Vite later than 2.4.2.
135+
136+
One alternative is [Vitest](https://vitest.dev/) which has an API compatible Jest.
129137

130138
### Using Parcel
131139

0 commit comments

Comments
 (0)