-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
Addons: Scaffold Addon Vitest #28810
Addons: Scaffold Addon Vitest #28810
Conversation
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.
29 file(s) reviewed, 5 comment(s)
Edit PR Review Bot Settings
) => { | ||
return async ({ task, skip }: TaskContext) => { | ||
const Story = (await getStories(modulePath, composeStoriesFn))[exportName]; | ||
if (Story === undefined || shouldSkip(Story.tags, tagsFilter)) { |
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.
logic: Potential issue if Story.tags
is undefined. Consider adding a check.
}; | ||
_task.meta.storyId = Story.id; | ||
_task.meta.hasPlayFunction = !!Story.play; | ||
await setViewport(Story.parameters.viewport); |
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.
logic: Potential issue if Story.parameters.viewport
is undefined. Consider adding a check.
|
||
let page: BrowserPage; | ||
try { | ||
const importPath = '/@id/__x00__@vitest/browser/context'; |
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.
style: Consider handling the case where importPath
fails more gracefully.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 12e0350. 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. |
ee720ec
to
52aa6fd
Compare
code/addons/vitest/package.json
Outdated
"exports": { | ||
".": { | ||
"types": "./dist/index.d.ts", | ||
"node": "./dist/index.cjs", |
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.
Do we need a cjs bundle?
Closes #
What I did
This PR bases on the work from #28749 and does the following:
The work in #28749 will be revisited later once we introduce UI coming from the addon. Fow now we are focusin on the CLI aspect of it.
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:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>
Greptile Summary
Introduced a new Vitest addon for Storybook, integrating Vitest test results with Storybook stories.
code/.storybook/main.ts
to include the Vitest addon.code/.storybook/storybook.setup.ts
for Vitest setup.code/addons/vitest/src/plugin/index.ts
to configure the Vitest plugin.code/core/src/manager-api/modules/stories.ts
to enhanceexperimental_updateStatus
.code/package.json
to include@storybook/experimental-addon-vitest
and@vitest/browser
dependencies.