Addon-Vitest: Fix incorrect Vitest config snippet #32228
Merged
Conversation
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
kylegach
added
documentation
patch:yes
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
View your CI Pipeline Execution ↗ for commit 49a8e30
☁️ Nx Cloud last updated this comment at |
jonniebigodes
approved these changes
Aug 11, 2025
* next: (533 commits) Update skipPaths in copyAllStaticFiles to use outputDir for correct file handling Fix skipPaths in copyAllStaticFilesRelativeToMain to reference outputDir instead of targetPath auto trigger canary release based on branch name bust cache Refactor imports across multiple files to use named import for 'ts-dedent' for consistency and clarity reduce size of remove flaky story capture Refactor mocking utilities to enhance path resolution fix unit test Refactor imports in various files to include isCI and optionalEnvToBoolean for improved configuration handling Add new error classes for global settings and CommonJS config support Refactor CircleCI configuration to streamline job definitions and improve readability Update CHANGELOG.md for v9.1.2 [skip ci] Bump version from "9.2.0-alpha.2" to "9.2.0-alpha.3" [skip ci] Write changelog for 9.2.0-alpha.3 [skip ci] make RN sandboxes use src/stories directory Docs: Move button in ArgsTable heading to fix screenreader announcements Docs: Fix preview examples imports Docs: Fix incorrect CSF constructs Fix "Cannot read properties of undefined (reading 'push')" ...
This was referenced Aug 18, 2025
Merged
ndelangen
changed the title
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
Docs: Fix incorrect Vitest config snippet (cherry picked from commit fd90530)
ndelangen
pushed a commit
that referenced
this pull request
Aug 20, 2025
Docs: Fix incorrect Vitest config snippet (cherry picked from commit fd90530)
ndelangen
pushed a commit
that referenced
this pull request
Aug 21, 2025
Docs: Fix incorrect Vitest config snippet (cherry picked from commit fd90530)
github-actions
bot
added
the
patch:done
ndelangen
removed
the
patch:yes
8 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.
What I did
Per Vitest docs, two changes:
extendsproperty in correct locationdefineProjectfor better type-safetyChecklist for Contributors
Testing
Manual testing
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.Greptile Summary
This PR fixes critical documentation errors in the Vitest configuration examples for the
@storybook/addon-vitestpackage. The changes address two key issues that would cause configuration failures for users copying the examples:Corrected
extendsproperty placement: Theextends: trueproperty was incorrectly placed at the roottestconfiguration level. According to Vitest documentation, when using project configurations withdefineProject, theextendsproperty must be placed inside the project configuration object, not at the root level.Added missing
defineProjectimport: The Vue and Svelte configuration examples were using thedefineProjectfunction without importing it. This function provides better type safety for project configurations and must be imported fromvitest/config.The fix updates the documentation snippets in
docs/_snippets/vitest-plugin-vitest-config.mdto align with official Vitest documentation patterns. This ensures users can successfully copy and use the configuration examples without encountering TypeScript errors or runtime configuration issues. The changes affect three framework examples (React, Vue, and Svelte), making the documentation consistent and functional across all supported frameworks.Confidence score: 5/5