docs: introduce beforeEach / beforeAll returns #607
Conversation
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR documents a feature in Rstest where beforeEach and beforeAll hooks can return cleanup functions that automatically run after tests complete. The documentation is added to both English and Chinese versions of the migration guide and API reference.
- Documents return function capabilities for beforeEach/beforeAll hooks
- Provides code examples showing cleanup pattern implementation
- Updates both migration guide and API documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/docs/zh/guide/migration/jest.mdx | Adds Chinese documentation for hook return functions in Jest migration guide |
| website/docs/zh/api/test-api/hooks.mdx | Adds Chinese API documentation with examples for beforeAll and beforeEach return functions |
| website/docs/en/guide/migration/jest.mdx | Adds English documentation for hook return functions in Jest migration guide |
| website/docs/en/api/test-api/hooks.mdx | Adds English API documentation with examples for beforeAll and beforeEach return functions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ```diff | ||
| - beforeEach(() => doSomething()); | ||
| + beforeEach(() => { doSomething() }); |
There was a problem hiding this comment.
The migration example doesn't clearly demonstrate the cleanup function feature being documented. The diff only shows adding braces around doSomething() without showing how to return a cleanup function. Consider showing an example that actually returns a cleanup function to illustrate the feature.
| + beforeEach(() => { doSomething() }); | |
| + beforeEach(() => { | |
| + doSomething(); | |
| + return () => cleanupSomething(); | |
| + }); |
|
|
||
| ```diff | ||
| - beforeEach(() => doSomething()); | ||
| + beforeEach(() => { doSomething() }); |
There was a problem hiding this comment.
The migration example doesn't clearly demonstrate the cleanup function feature being documented. The diff only shows adding braces around doSomething() without showing how to return a cleanup function. Consider showing an example that actually returns a cleanup function to illustrate the feature.
| + beforeEach(() => { doSomething() }); | |
| - afterEach(() => cleanupSomething()); | |
| + beforeEach(() => { | |
| + doSomething(); | |
| + return () => cleanupSomething(); | |
| + }); |
Summary
The return functions of the
beforeEachandbeforeAllhooks in Rstest are used to perform cleaning work after testing.Related Links
Checklist