Webpack5: Make export-order-loader compatible with both esm and cjs #25540
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #25383
What I did
The new webpack loader added in #24749 assumes the code is ES (parses it with
es-module-lexer
to find the exports). Sometimes the code is CommonJS though, for example if@babel/plugin-transform-modules-commonjs
is used directly or indirectly. In that case the loader doesn't find the exports and the source output is CommonJS mixed with ES which leads to an "exports is not defined" error.This change will try to get the named exports with
cjs-module-lexer
if it can't find any exports or imports withes-module-lexer
, and will add;module.exports.__namedExportsOrder = ${namedExportsOrderString};
instead of;export const __namedExportsOrder = ${namedExportsOrderString};
in that case.This also includes the changes in #25506 to skip the loader if it fails for some reason, as it isn't crucial for Storybook to work properly.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
I tested the change in mlazari/sbsandbox@c63f4fe
Output source of the loader with and without
@babel/plugin-transform-modules-commonjs
: https://github.com/mlazari/sbsandbox/blob/main/loader-changes.mdDocumentation
MIGRATION.MD
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 pull request has been released as version
0.0.0-pr-25540-sha-c0037961
. Try it out in a new sandbox by runningnpx [email protected] sandbox
or in an existing project withnpx [email protected] upgrade
.More information
0.0.0-pr-25540-sha-c0037961
next
c0037961
1705406851
)To request a new release of this pull request, mention the
@storybookjs/core
team.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=25540