Addon Test: Support story name as test description #29147
Conversation
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
| 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 8de3b0e. 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. |
There was a problem hiding this comment.
Hey @InfiniteXyy thanks a lot for your contribution! This was something we were planning to do, so thanks for speeding that up! I'd love if you could change the implemention to make it simpler, given that the underlying parsing tool (CsfTools) already handles extracting the story name.
I believe you can delete most of the code and use something like this:
const exportName = parsed._stories[exportName].name || exportName;
return getTestStatementForStory({
exportName,
node,
});Test cases:
CSF1/2
export const Story = () => {}
Story.storyName = 'custom name'CSF3
export const Story = () => {
name: 'custom name'
}Let me know how it goes and if you need anything else!
docs/writing-tests/vitest-plugin.mdx
Outdated
| ### How do I customized the test description | ||
|
|
||
| We are using the exportName of a story definition by default, but you can provide a `name` property for the story to customize the test description. This is useful when you want have places, brackets or other special characters in the test description. |
There was a problem hiding this comment.
Can you add a code snippet alongside this so users can understand it better?
export const Story = {
storyName: 'custom, descriptive name'
};| ### How do I customized the test description | |
| We are using the exportName of a story definition by default, but you can provide a `name` property for the story to customize the test description. This is useful when you want have places, brackets or other special characters in the test description. | |
| ### How do I customize the test description? | |
| By default, the export name of a story is mapped to the test name. You can provide a `name` property for the story to customize the test description, allowing you to write more descriptive names. This is useful when you want use spaces, brackets or other special characters in the test description. |
|
Also, can you share examples of how you are naming your stories for your tests? It's pretty useful for us to have an idea about use cases! Thanks! |
Hi, thank you for your code review and feed back. Each test cases should have a description like It's more like a sentense, because we want each test to have a meaningful description that represents a specific scenario. |
Thank you for your suggestions! It's helpful and by using I also try adding the test cases for csf v1/2 and function config, but I am not familiar with csf v1/2, hope I didn't do it wrong. |
yannbf
changed the title
|
Hey @InfiniteXyy I'm trying to wrap this PR up but I am not allowed to push to your remote. Would you mind allowing edits from maintainers in your fork? Thanks! |
I have enabled this, hope it's the correct place for allowing permission |
kasperpeulen
added
the
patch:yes
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
Addon Test: Support story name as test description (cherry picked from commit 0811ca8)
github-actions
bot
added
the
patch:done
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