Add support for storybook v8 #855
Conversation
indigolain
force-pushed
the
add-support-for-storybook-v8
branch
from
63823cc
to
321499d
Compare
indigolain
force-pushed
the
add-support-for-storybook-v8
branch
from
321499d
to
2010922
Compare
| - example_dir: examples/v8-react18 | ||
| node-version: 18.x |
There was a problem hiding this comment.
@storybook/react depends on node versions 18 and higher.
| return; | ||
| } | ||
| // for Storybook v5 | ||
| const stories = api.raw().map(_ => ({ id: _.id, kind: _.kind, story: _.name, version: 'v5' } as Story)); |
There was a problem hiding this comment.
Version might have been always pointing to v5?
Since version 8 could be distinguishable, I added a change to make it either v5 or v8.
There was a problem hiding this comment.
Version might have been always pointing to v5?
Yes. The version field comes from the fact that there was a significant difference in the way to manipulate SB's preview iframe operated between Storybook v4 and v5.
If there is no change in the way to operate the preview iframe in Storybook v8, then I think we can keep the version field v5.
There was a problem hiding this comment.
I see! Since there seems to be no change in the way to operate the preview iframe in version 8, i brought back the v5 with 456f8eb
indigolain
force-pushed
the
add-support-for-storybook-v8
branch
from
6f46f11
to
f104e77
Compare
examples/v8-react18/package.json
Outdated
| "@storybook/addon-actions": "^8.0.0", | ||
| "@storybook/addon-essentials": "^8.0.0", | ||
| "@storybook/addon-links": "^8.0.0", | ||
| "@storybook/addons": "^7.6.17", |
There was a problem hiding this comment.
Is this version intentional ?
"@storybook/addons": "^8.0.0",
I think the following error is related to this version mismatching 🤔
https://github.com/reg-viz/storycap/actions/runs/8294518431/job/22703172139?pr=855#step:7:88
There was a problem hiding this comment.
The @storybook/addons package has been deprecated since v7 was replaced by @storybook/manager-api and @storybook/preview-api.
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#new-addons-api
There was a problem hiding this comment.
Thanks! Yes, the @storybook/addons seems to be replaced, so we need to switch to using @storybook/manager-api and @storybook/preview-api.
However, the following files depend on @storybook/addons.
- packages/storycap/src/client/register.ts
- packages/storycap/src/client/with-screenshot.ts
So, I think that if we want to support the older versions of storybook, we might need to do either of the following
- A: find someway to detect the installed storybook version and maybe dynamically import the corresponding packages
- B: try to import the
@storybook/addonspackage and fallback to importing@storybook/manager-apior@storybook/preview-apiif it's not available
Which way seems better? B may look something like 365331c?
There was a problem hiding this comment.
@indigolain Thanks for planning of solution 👍
Your plan B looks good 😸
|
@indigolain Thanks for your great work ! |
|
@Quramy |
Accessing
__STORYBOOK_CLIENT_API__became unavailable in storybook version 8 along with some changes in theStoryStoremethods likestore.raw()which was called from storycrawler.I think this change should make storycap support storybook version 8 while keeping backward compatibility.
__STORYBOOK_CLIENT_API__: Storybook 8.0.0-beta.0 missing global __STORYBOOK_CLIENT_API__ storybookjs/storybook#25892