[Docs]: Documentation suggests the vite-jest library for vite compatibility, but vite-jest is obsolete and appears unmaintained.

[Jon-Biz]

Page(s)

The Vite section of the getting started page suggests the vite-jest library as a 'not fully supported' option for running jest test suites with vite projects. However, vite-jest requires a version of vite 3 major release versions behind the current iteration and appears unmaintained.

The relevant docs section:

https://jestjs.io/docs/getting-started#using-vite

Using Vite
Jest can be used in projects that use vite 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 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. Refer to the vite guide to get started.

---

vite-jest requires a peer dependencies of vite@"2.4.2" and jest@"^27.0.0". Vite is now at 5.2.13.

vite-jest appears unmaintained as of July 27 2023:

Additionally, the vite guide makes no reference to jest and is likely of no use to people attempting to port jest suites to vite, or otherwise use jest with vite.

Description

The section should be updated to inform vite users that they are probably out of luck, and either warn them of the limitations of the jest-vite library, or avoid mentioning it entirely.

Using Vite

Jest is not supported by vite due to how the plugin system from vite works.

There are examples for jest integration with vite in the vite-jest library, however as of 5/10/24 this library is not compatible with versions of vite later than 2.4.2.

[mrazauskas]

Do you suggest to remove those lines on vite-jest from the docs?

[Jon-Biz]

Sorry, yes the form seemed to suggest that the second markdown field would be more clearly displayed. I was proposing changing it to the copy in the description section above. To wit:

---

Using Vite

Jest is not supported by vite due to how the plugin system from vite works.

There are examples for jest integration with vite in the vite-jest library, however as of 5/10/24 this library is not compatible with versions of vite later than 2.4.2.

---

[mrazauskas]

Thanks! This looks good to me. I mean, the situation is odd, but your text explains it better. Would you like to open a PR with this change?

[Jon-Biz]

Will do.