Skip to content

Core: Support CJS presets in frameworks#32035

Merged
JReinhold merged 1 commit into
sb10/esm-onlyfrom
jeppe/allow-cjs-frameworks
Jul 14, 2025
Merged

Core: Support CJS presets in frameworks#32035
JReinhold merged 1 commit into
sb10/esm-onlyfrom
jeppe/allow-cjs-frameworks

Conversation

@JReinhold
Copy link
Copy Markdown
Contributor

@JReinhold JReinhold commented Jul 14, 2025

Closes #

What I did

Added the 'require' condition to the default 'node', 'import' (and 'default' being implicit) to the framework validation check. Our preset loading supports require just fine, so the validation logic should support it too. This issue was discovered while QAing against https://storybook.nuxtjs.org

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!

Documentation

  • 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

This PR adds support for CommonJS (CJS) presets in Storybook frameworks by modifying the framework validation check to include the 'require' condition alongside the existing 'node' and 'import' conditions. The change was prompted by compatibility issues discovered during NuxtJS integration testing.

The modification is made to the validate-config.ts file where it adds 'require' to the conditions array when resolving framework paths. This change ensures that both ESM and CJS module formats are properly supported during framework validation, which is essential for maintaining backward compatibility while the ecosystem transitions to ESM.

Confidence score: 4/5

  1. This PR is safe to merge as it extends existing functionality without breaking changes
  2. The score is high because this is a straightforward addition that aligns with existing preset loading behavior and fixes a real-world issue discovered during QA
  3. Files needing attention:
    • code/core/src/common/utils/validate-config.ts - Verify that the added 'require' condition doesn't interfere with existing ESM-only frameworks

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

Copy link
Copy Markdown
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.

Reviewing changes made in this pull request

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Jul 14, 2025

View your CI Pipeline Execution ↗ for commit 5047401

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 52s View ↗

☁️ Nx Cloud last updated this comment at 2025-07-14 12:36:53 UTC

@JReinhold JReinhold merged commit b44bfb7 into sb10/esm-only Jul 14, 2025
29 of 34 checks passed
@JReinhold JReinhold deleted the jeppe/allow-cjs-frameworks branch July 14, 2025 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants