Skip to content
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

Vue3: Introduce portable stories API #25443

Merged
merged 9 commits into from
Jan 24, 2024
Merged

Vue3: Introduce portable stories API #25443

merged 9 commits into from
Jan 24, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jan 3, 2024

Relates to storybookjs/testing-vue3#14

What I did

This PR introduces the mechanism which is currently available in https://github.com/storybookjs/testing-vue3 but now as part of the @storybook/vue3 package instead.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

@yannbf yannbf force-pushed the feat/portable-stories-vue3 branch from 4f43cff to 92f412d Compare January 22, 2024 09:26
Docs: Vue 3 Unit testing changes for Portable stories
Copy link

socket-security bot commented Jan 22, 2024

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

@vanessayuenn vanessayuenn added this to the 8.0-beta milestone Jan 22, 2024
code/renderers/vue3/src/testing-api.ts Outdated Show resolved Hide resolved
code/renderers/vue3/src/testing-api.ts Outdated Show resolved Hide resolved
docs/writing-tests/stories-in-unit-tests.md Outdated Show resolved Hide resolved
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great -- fantastic work @yannbf !!! 💪

@yannbf yannbf force-pushed the feat/portable-stories-vue3 branch from 4cbaed6 to dbbf2dc Compare January 22, 2024 16:26
@chakAs3
Copy link
Contributor

chakAs3 commented Jan 23, 2024

i was waiting for this @yannbf finally Good Job you did not even need my help

@chakAs3 chakAs3 self-requested a review January 23, 2024 12:59
Comment on lines +49 to +50
* import { render } from '@testing-library/vue';
* import { composeStory } from '@storybook/vue3';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

However it is time to fix the render function in Vue render to match the official test api, there is a bit of issue here
I find that the testing-library/vue is more legit that the render function in @storybook/vue3
Also i suggest to rename @storybook/vue3 , @storybook/vue, to match with vue current naming convention. and rename @storybook/vue to @storybook/vue2.7 . we need to be consistent with other api so users won't be confused

NB:Dropping Vue 2.7 is recommended

@chakAs3
Copy link
Contributor

chakAs3 commented Jan 23, 2024

However it is time to fix the render function in Vue render to match the official test api, there is a bit of issue here
I find that the testing-library/vue is more legit that the render function in @storybook/vue3
Also i suggest to rename @storybook/vue3 , @storybook/vue, to match with vue current naming convention. and rename @storybook/vue to @storybook/vue2.7 . we need to be consistent with other api so users won't be confused

NB:Dropping Vue 2.7 is recommended

@yannbf yannbf force-pushed the feat/portable-stories-vue3 branch from e97b6b7 to 2162447 Compare January 23, 2024 15:28
@yannbf yannbf force-pushed the feat/portable-stories-vue3 branch from 2162447 to f52e96f Compare January 23, 2024 15:43
@yannbf yannbf merged commit 6733062 into next Jan 24, 2024
60 checks passed
@yannbf yannbf deleted the feat/portable-stories-vue3 branch January 24, 2024 14:12
@github-actions github-actions bot mentioned this pull request Jan 24, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants