Skip to content

Conversation

@JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Oct 15, 2025

Follow up to #32641

What I did

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>

Summary by CodeRabbit

  • Documentation
    • Updated migration guide to state that both main configuration and custom presets must be valid ESM.
    • Clarified that extensionless relative imports are no longer supported in JavaScript-based configs; explicit file extensions are required.
    • Added examples for migrating from CJS to ESM and recommended extension practices.
    • Clarified Node.js version requirements and module resolution guidance.
    • Included notes for TypeScript configurations and aligned wording across sections.

@JReinhold JReinhold self-assigned this Oct 15, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

📝 Walkthrough

Walkthrough

Documentation updates expand ESM requirements to include Storybook presets, require explicit file extensions in JS-based configs/presets, add CJS-to-ESM migration examples, clarify Node.js and tsconfig requirements, and replace require.resolve examples with import.meta.resolve. Related release notes are updated accordingly.

Changes

Cohort / File(s) Summary of edits
Docs: Migration ESM and presets guidance
MIGRATION.md, docs/releases/migration-guide.mdx
Broadened ESM requirement to include presets; added guidance on explicit extensions for JS-based config/presets; updated examples from CJS to ESM with explicit extensions; noted TS may still allow extensionless imports; clarified Node.js and tsconfig.moduleResolution; switched path resolution examples to use import.meta.resolve; minor text edits.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jeppe/fix-preset-migration-note

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d944892 and 631ea19.

📒 Files selected for processing (2)
  • MIGRATION.md (3 hunks)
  • docs/releases/migration-guide.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Update documentation under docs/ for significant changes, including migration guides for breaking changes

Files:

  • docs/releases/migration-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Core Unit Tests, windows-latest

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Oct 15, 2025

View your CI Pipeline Execution ↗ for commit cb041b1

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

☁️ Nx Cloud last updated this comment at 2025-10-15 14:43:23 UTC

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Nice!

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Oct 15, 2025
@kylegach kylegach merged commit 4a0464b into next Oct 15, 2025
9 of 10 checks passed
@kylegach kylegach deleted the jeppe/fix-preset-migration-note branch October 15, 2025 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants