docs(guide): document the vite-plus/test import surface - #2413
Open
jong-kyung wants to merge 6 commits into
Open
docs(guide): document the vite-plus/test import surface#2413jong-kyung wants to merge 6 commits into
jong-kyung wants to merge 6 commits into
Conversation
✅ Deploy Preview for viteplus-preview canceled.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The test guide explains how to run and configure
vp test, but it never shows where test APIs likedescribe,it,expect, andvishould be imported from. Thevite-plus/testimport surface is currently only documented in the migration guide, so a user who starts a new project and only reads the test guide may installvitestdirectly even though a singlevite-plusinstall is enough.This PR adds a short paragraph and an import example to the Overview section of
docs/guide/test.md. The browser mode subpaths (vite-plus/test/browser*) are already covered in the migration guide, so the new section links to Migrating Vitest instead of duplicating them.Closes #2412