Docs: Module mocking, and more #26858
Merged
Conversation
This file contains 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
- Providers
- Configuring mocked providers with parameters
- Network requests
- Bad link
- Modules
- Better mock files section
- Using mocked files in stories
- Warning for absolute imports & mocking - Module aliases - Subpath imports - Mocking modules - `@storybook/nextjs/cache.mock` module API
- Decorators
- Focus the "context" section on only that argument
- Move irrelevant examples and snippets to the Story rendering page
- Interaction Testing
- Under the Write an interaction test section, add:
- Run code before each test section
- Mocked modules section
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 2a0d245. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
Co-authored-by: Jeppe Reinhold <jeppe@chromatic.com>
kylegach
commented
Apr 18, 2024
- Next.js
- Add portable stories section
- Mocking modules
- Clarify requirements of mock files
- Prose and snippet tweaks
- Interaction testing
- Bring over `mockdate` example
- Prose and snippet tweaks
kylegach
force-pushed
the
module-mocking-docs
branch
from
4e9b1ec
to
2ac03c4
Compare
kylegach
commented
Apr 18, 2024
JReinhold
reviewed
Apr 18, 2024
JReinhold
reviewed
Apr 18, 2024
Other improvements: - Consistency improvements in snippets throughout - Prose tweaks
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: Yann Braga <yannbf@gmail.com>
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
- Re-order TOC items - Fix conditional content - Improve nextjs module API references - Make example snippets more consistent - Re-organize subpath imports section of module mocking guide - Fix typos, grammar
kylegach
force-pushed
the
module-mocking-docs
branch
from
1d14a89
to
01c6509
Compare
yannbf
reviewed
May 1, 2024
yannbf
reviewed
May 1, 2024
yannbf
reviewed
May 1, 2024
yannbf
reviewed
May 1, 2024
docs/snippets/react/msw-addon-configure-handlers-graphql.js.mdx
Outdated
Show resolved
Hide resolved
yannbf
reviewed
May 1, 2024
yannbf
reviewed
May 1, 2024
yannbf
approved these changes
May 1, 2024
- Make nextjs module alias usage more clear - Update msw graphql snippets - Add preact support for mocking providers - Prose improvements
jonniebigodes
requested changes
May 3, 2024
docs/snippets/react/configure-mock-provider-with-story-parameter.ts-4-9.mdx
Outdated
Show resolved
Hide resolved
- Snippet consistency - Prose tweaks
jonniebigodes
approved these changes
May 3, 2024
19 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #26795, closes #26796, closes #26797
What I did
Add or update docs for:
testpropertiesChecklist for Contributors
Testing
Manual testing
module-mocking-docsDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>