-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Docs: Fix providerImportSource extension #26868
Docs: Fix providerImportSource extension #26868
Conversation
@@ -5,7 +5,7 @@ export * from '@storybook/addon-docs/dist/preset'; | |||
export const mdxLoaderOptions = async (config: any) => { | |||
config.mdxCompileOptions.providerImportSource = join( | |||
dirname(require.resolve('@storybook/addon-docs/package.json')), | |||
'/dist/shims/mdx-react-shim' | |||
'/dist/shims/mdx-react-shim.mjs' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This exact line is causing a bug for me.
I was wondering why do you even need to override providerImportSource
in this @storybook/addon-essentials
preset? I mean wouldn't providerImportSource
be covered for webpack and vite builder by 2 other files? Maybe instead of fixing it by providing the extension it's better to remove this entire override in this file? I have a setup similar to vite where this is already provided by the builder, so not sure why addon (especially the essentials
addon) is overriding this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ndelangen could you provide the context here? Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uhm... don't have the context why it's needed, though I think @JReinhold probably does.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that this doesn't look necessary to me. You can try removing it and see if CI still works.
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 0255264. 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. |
@ndelangen thanks for looking into this! |
Hi @bashmish! Thanks so much for fixing this. We have lots of PRs and our workflow is set up to release |
@shilman thanks for clear explanation, too bad, but fine by me, I implemented a workaround on my side and will keep it for 7.x.x then. Given the answer in #26868 (comment), I'd like to try fixing this as discussed in that thread, because it seems more future proof to me for custom builders. UPDATE: on a second thought, let's keep this PR as is and release it, it's a good fix on its own. Removing the other code might take a while for everything to go through, so it's best to keep it in a separate PR for later. |
What I did
Added extension to the path which is needed in my builder
More info: modernweb-dev/web#2703
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
N/A
Manual testing
I tested in my repo by manually adding an extension.
Documentation
N/A
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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>