-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
Addon Vitest: support read story name for vitest test description #29147
base: next
Are you sure you want to change the base?
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.
3 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings
for (const prop of storyDeclarator.init.properties) { | ||
if ( | ||
// Filter out the "name" property and return its value | ||
prop.type === 'ObjectProperty' && | ||
prop.key.type === 'Identifier' && | ||
prop.value.type === 'StringLiteral' && | ||
prop.key.name === 'name' | ||
) { | ||
return prop.value.value; | ||
} | ||
} | ||
} |
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 using find
instead of for
loop for better readability
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.
With find, the type will be hard to define
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 26c2865. 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. |
What I did
I added a new feature to the newly published
vitest-test
plugin:Now the test description will use the explictly settled
name
of the story, and then fallback to theexportName
.The requirement comes from that developers might want to have spaces/brackets/etc... in the test description, which is not allowed in exportName.
At the same time, this can also keep consistent with the name display in storybook preview.
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
This PR enhances the Vitest plugin for Storybook by allowing customizable test descriptions using the story's 'name' property, improving readability and consistency with the Storybook preview.
code/core/src/csf-tools/vitest-plugin/transformer.ts
to prioritize story 'name' over 'exportName' for test descriptionscode/core/src/csf-tools/vitest-plugin/transformer.test.ts
to verify the 'name' property usagedocs/writing-tests/vitest-plugin.mdx
with instructions on customizing test descriptions using the 'name' property