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

CPC: Add ESM export to docs-tools & node-logger packages #28539

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Jul 10, 2024

What I did

I added back the ESM export to the @storybook/docs-tools package.

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/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>

@ndelangen ndelangen self-assigned this Jul 10, 2024
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.

PR Summary

  • Added import and module fields in code/deprecated/docs-tools/package.json for ESM support
  • Introduced code/deprecated/docs-tools/shim.mjs to re-enable ESM exports
  • Ensured compatibility with ESM environments by exporting from storybook/internal/docs-tools

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@ndelangen ndelangen added bug patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Jul 10, 2024
@ndelangen ndelangen changed the title CPC: Add mjs export to csf-tools shim package CPC: Add ESM export to csf-tools shim package Jul 10, 2024
@ndelangen ndelangen requested a review from JReinhold July 10, 2024 21:41
Copy link

nx-cloud bot commented Jul 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a151dd1. 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 target

Sent with 💌 from NxCloud.

@JReinhold JReinhold changed the title CPC: Add ESM export to csf-tools shim package CPC: Add ESM export to docs-tools shim package Jul 10, 2024
@ndelangen ndelangen changed the title CPC: Add ESM export to docs-tools shim package CPC: Add ESM export to docs-tools & node-logger packages Jul 10, 2024
@ndelangen ndelangen merged commit 4997e09 into next Jul 10, 2024
54 of 55 checks passed
@ndelangen ndelangen deleted the norbert/cpc-add-mjs-to-csf-tools-shim branch July 10, 2024 22:26
storybook-bot pushed a commit that referenced this pull request Jul 10, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 10, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
storybook-bot pushed a commit that referenced this pull request Jul 11, 2024
…-tools-shim

CPC: Add `ESM` export to `docs-tools` & `node-logger` packages
(cherry picked from commit 4997e09)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants