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

Addon-docs: Fix doc blocks imports to import from ESM/CJS #14841

Merged
merged 4 commits into from
May 7, 2021

Conversation

shilman
Copy link
Member

@shilman shilman commented May 7, 2021

Issue: #13478

What I did

Move to importing from @storybook/addon-docs instead of @storybook/addon-docs/blocks so that we can import from either CJS or ESM automatically

self-merging @ndelangen @kylegach

How to test

Does CI pass?

@nx-cloud
Copy link

nx-cloud bot commented May 7, 2021

Nx Cloud Report

CI ran the following commands for commit 412eb52. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

Status Command
#000000 nx run-many --target=prepare --all --parallel --max-parallel=15

Sent with 💌 from NxCloud.

@shilman shilman changed the title Fix doc blocks imports to import from ESM/CJS Addon-docs: Fix doc blocks imports to import from ESM/CJS May 7, 2021
MIGRATION.md Outdated
@@ -209,7 +230,7 @@ Many Storybook packages are now available as ESModules in addition to CommonJS.

```js
// In your jest config
transformIgnorePatterns: ['/node_modules/(?!@storybook)']
transformIgnorePatterns: ['/node_modules/(?!@storybook)'];
Copy link
Contributor

Choose a reason for hiding this comment

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

Tiny nit, but this line of config is likely either in an object or JSON, so the semi-colon is a syntax error.

More importantly, should we update the text above this to inform people that this isn't necessary in 6.3?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, updated!

@shilman shilman merged commit 70bc53d into next May 7, 2021
@shilman shilman deleted the 13478-fix-doc-blocks-imports branch May 7, 2021 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants