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

Include nested files in ESM compilation #30441

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

edbzn
Copy link

@edbzn edbzn commented Feb 2, 2025

What I did

Fixed a compilation issue where nested ESM compiled files are overridden by CJS one due to a misconfiguration in the glob pattern when renaming files to .mjs.

Before, nested ESM files (like angular/dist/client/render.mjs) are not properly produced:

image

After, nested ESM files are correctly produced:

image

It is particularly an issue with @storybook/testing-angular where deep imports are used but proper ESM modules are not produced, leading to errors like:

image

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/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>

Greptile Summary

Modified the glob pattern in TypeScript compilation script to properly handle nested ESM files, ensuring correct module format output for deep imports.

  • Changed glob pattern from 'dist/*.js' to 'dist/**/*.js' in scripts/prepare/tsc.ts to include nested directory files
  • Fixed issue where nested ESM files (e.g. angular/client/render.mjs) were being overridden by CommonJS versions
  • Addresses compilation errors in @storybook/testing-angular where deep imports require proper ESM modules
  • Ensures consistent module format output across nested directory structures

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +62 to 63
const files = globSync(join(process.cwd(), 'dist', '**/*.js'));
await Promise.all(files.map((file) => move(file, file.replace('.js', '.mjs'), {})));
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider adding error handling around the file move operations in case of permission issues or disk space constraints

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant