Skip to content

Document considerations when using Vitest #81

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

Merged
merged 1 commit into from
May 23, 2025
Merged

Document considerations when using Vitest #81

merged 1 commit into from
May 23, 2025

Conversation

acelaya
Copy link
Contributor

@acelaya acelaya commented May 22, 2025

This PR extends the documentation on how we use Vitest, explaining the differences between our setup and the standard assumptions Vitest does.

One thing all projects need to do when using Vitest is defining to options when using babel-plugin-istanbul. This library now exposes an object with those options, so that we don't need to repeat them in every project with a comment explaining why they need to be set.

Additionally, this makes Vitest no longer an optional dependency, and exports everything in the vitest module from the main entry point.

The /vitest entry point has been preserved for backwards compatibility, but it is now mostly redundant.

"vitest": {
"optional": true
}
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have checked that all projects that depend on this library are already using vitest as well.

@acelaya acelaya requested a review from robertknight May 22, 2025 12:09
@acelaya acelaya force-pushed the vitest-docs branch 2 times, most recently from 26ce3c7 to d00834e Compare May 23, 2025 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants