-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Docs: Adjust mocking modules #32808
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
Docs: Adjust mocking modules #32808
Conversation
|
View your CI Pipeline Execution ↗ for commit f472ebf
☁️ Nx Cloud last updated this comment at |
📝 WalkthroughWalkthroughA new troubleshooting subsection titled "Mocking conflicts with other testing tools" was added to documentation explaining potential conflicts between Storybook's mocking system and other testing tools (e.g., Jest), risks of overlapping configurations, and recommended resolution approaches. The subsection appears twice in the document. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx (1)
335-337: Troubleshooting guidance could be more specific and actionable.The new subsection addresses the right problem (conflicts between Storybook and other test-runner mocks per issue #32595), but the recommended solution is somewhat generic. Users may benefit from more concrete guidance—for example:
- How to identify which tool owns a particular
__mocks__file- Specific naming or directory patterns to distinguish Storybook mocks from Jest mocks
- Examples of what "non-overlapping configurations" looks like
Consider adding a brief example or link to show how users can organize mocks to avoid conflicts (e.g., separate mock strategies per tool, or tool-specific mock directories).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Update documentation under
docs/for significant changes, including migration guides for breaking changes
Files:
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
docs/writing-stories/mocking-data-and-modules/mocking-modules.mdx (1)
335-337: Verify that the new subsection is not duplicated elsewhere in the document.The AI-generated summary indicates that this "Mocking conflicts with other testing tools" subsection appears in two locations within the document (once here and again at the end of the Troubleshooting section). The provided code shows only one instance, making it unclear whether this is an oversight or intentional repetition. Please confirm whether duplication exists and, if so, whether it should be consolidated into a single location to avoid redundancy.
Closes #32595
What I did
With this pull request the documentation was updated to include a small troubleshooting entry to provide some context on the issue
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
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-storybook/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 publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit