feat: add annotations support for addons #612
Conversation
|
Thanks for your contribution 🙏. I'm not at home but I will give a try soon. Probably this can go in a v8 prerelease shortly. |
| } | ||
| const isPreviewFileExists = getPreviewExists({ configPath: addonPath }); | ||
| if (isPreviewFileExists) { | ||
| enhancer.push(`require('${addon}/dist/preview')`); |
There was a problem hiding this comment.
Seems like this would be without dist in the path otherwise the check would be wrong. Since getPreviewExists is checking for the root of the package from what I can see
Also we can have @storybook/addon-ondevice-actions re-export the actions preview in @storybook/addon-actions/preview so that we can follow that pattern.
enhancer.push(`require('${addon}/preview')`);
There was a problem hiding this comment.
I think if we remove the /dist path, the bundler will get the raw code since node_modules is ignored. Plus, the source file can be anywhere, but according to the docs, it should be bundled into the dist directory:
https://storybook.js.org/docs/addons/writing-addons#module-metadata But probably, we could look for a file in the dist directly.
I love the idea of re-exporting @storybook/addon-actions/preview. I just wanted to focus on the specific issue I'm facing here and don't touch anything else
There was a problem hiding this comment.
Well if this is the case then the check should be changed to look for the dist folder
I.e getpreviewpath(addonpath/dist)
There was a problem hiding this comment.
I guess you already updated it but i will also check how its handled in storybook core before moving forward
There was a problem hiding this comment.
Well if this is the case then the check should be changed to look for the dist folder
I.e getpreviewpath(addonpath/dist)
It won't work as the package is resolving to the /dist path. Try to play with it a little pls And let me know how to proceed
There was a problem hiding this comment.
I believe that if the exports field from package.json is used in the package like in the docs here
"exports": {
".": {
"types": "./dist/index.d.ts",
"node": "./dist/index.js",
"require": "./dist/index.js",
"import": "./dist/index.mjs"
},
"./manager": "./dist/manager.mjs",
"./preview": "./dist/preview.mjs",
"./package.json": "./package.json"
},
then this allows the import from package-name/preview assuming that package exports are enabled for metro which they are required to be for rn storybook 8
There was a problem hiding this comment.
yep, so now should work as expected
|
I think it would be really cool to add deep controls to the example app so we can have an example of this being used in the project, what do you think? |
Guess it's nice to have as it's pretty hard to modify jsons on mobile. Let's wait for the PR eliasm307/storybook-addon-deep-controls#24 to be merged |
dannyhw
changed the title
dannyhw
changed the title
Issue:
What I did
Added support for preview files if they are present in the addon module
I required support for the storybook-addon-deep-controls addon, but it wasn't compatible with the React Native version of Storybook. This pull request will introduce support for this module and potentially others. Specifically for this addon, I've added a preview file to the root directory as it was previously only available in the dist directory. This modification will ensure compatibility and provide a foundation for integrating other modules in the future
How to test