-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs: explain globalSetup/setupFiles and add Lifecyle page #9385
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
base: main
Are you sure you want to change the base?
docs: explain globalSetup/setupFiles and add Lifecyle page #9385
Conversation
✅ Deploy Preview for vitest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation about Vitest's test run lifecycle and improves existing documentation for globalSetup and setupFiles configuration options.
- Adds a new "Test Run Lifecycle" guide page explaining all phases of a Vitest test run from initialization to teardown
- Enhances
globalSetupdocumentation with clearer examples and better structure - Improves
setupFilesdocumentation to clarify execution context and relationship to other lifecycle phases
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guide/lifecycle.md | New comprehensive guide covering all 7 phases of the test lifecycle with examples, tables, and cross-references |
| docs/config/setupfiles.md | Enhanced with clearer explanations of execution context, timing, and differences from globalSetup |
| docs/config/globalsetup.md | Improved with better code examples, added section on onTestsRerun hook, and clarified scope differences |
| docs/config/sequence.md | Minor improvement to clarity of phrasing about test dependencies |
| docs/.vitepress/config.ts | Added navigation entry for new lifecycle guide and expanded Advanced sections |
Description
Resolves #issue-number
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.