From cce44d767e5e1d5c62eaaf5f93fb73748c25266b Mon Sep 17 00:00:00 2001 From: Jonathan El-Bizri Date: Fri, 12 Jul 2024 01:54:34 -0700 Subject: [PATCH] Update GettingStarted.md with current Vite related information (#15122) --- docs/GettingStarted.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md index 053273934c01..58ab204d3955 100644 --- a/docs/GettingStarted.md +++ b/docs/GettingStarted.md @@ -119,13 +119,21 @@ module.exports = { +## Using with bundlers + +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. + ### Using webpack 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. ### Using Vite -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. +Jest is not supported by Vite due to incompatibilities with the Vite [plugin system](https://github.com/vitejs/vite/issues/1955#issuecomment-776009094). + +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. + +One alternative is [Vitest](https://vitest.dev/) which has an API compatible Jest. ### Using Parcel