Addon Vitest: support read story name for vitest test description #29147
+64
−1
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
InfiniteXyy
requested review from
kylegach and
jonniebigodes
as code owners
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
3 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings
Comment on lines
218
to
229
| 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.
style: Consider using find instead of for loop for better readability
There was a problem hiding this comment.
With find, the type will be hard to define
☁️ Nx Cloud ReportCI is running/has finished running commands for commit a70830b. 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. |
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
I added a new feature to the newly published
vitest-testplugin:Now the test description will use the explictly settled
nameof 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: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>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.tsto prioritize story 'name' over 'exportName' for test descriptionscode/core/src/csf-tools/vitest-plugin/transformer.test.tsto verify the 'name' property usagedocs/writing-tests/vitest-plugin.mdxwith instructions on customizing test descriptions using the 'name' property