Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GettingStarted.md with current Vite related information #15122

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

Jon-Biz
Copy link
Contributor

@Jon-Biz Jon-Biz commented Jun 11, 2024

Summary

As per #15121 the current information regarding usage with Vite is out of date. The recommended compatibility library vite-jest appears to be unmaintained and is not compatible with the current Vite release.

Additionally, this change points users to Vitest, a currently maintained alternative to which I have found migration relatively painless.

Test plan

No tests, just documentation.

Screenshot 2024-06-11 at 12 39 22 PM

Copy link

linux-foundation-easycla bot commented Jun 11, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: Jon-Biz / name: Jonathan El-Bizri (ccabc42)
  • ✅ login: SimenB / name: Simen Bekkhus (5017683, 3ce5f61)

Copy link

netlify bot commented Jun 11, 2024

Deploy Preview for jestjs ready!

Name Link
🔨 Latest commit 3ce5f61
🔍 Latest deploy log https://app.netlify.com/sites/jestjs/deploys/6690ef1a4064a200082ffc86
😎 Deploy Preview https://deploy-preview-15122--jestjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mrazauskas
Copy link
Contributor

Thanks. I was looking at the text again. Perhaps it would be enough to say that Vite's plugins are not compatible with Jest's transforms? And to point to the issue in Vite's repo? Users can find all details and possible solutions there.

Also it does not look right to advertise another testing framework. That's for sure is a red flag (;

@StefanoFrazzetto
Copy link

@mrazauskas as a new Vite + Vitest user, I find that it helps having some context about other tools that have been used in the past and are no longer recommended or don't work anymore, since you can still find posts recommending vite-jest on StackOverflow or other places

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they've copy pasted so much code it's weird, but I do agree with linking to them as the alternative is deprecated 😀

docs/GettingStarted.md Outdated Show resolved Hide resolved
@SimenB SimenB merged commit cce44d7 into jestjs:main Jul 12, 2024
8 of 9 checks passed
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants