Skip to content

Core: Delete shim addon packages#31728

Merged
ndelangen merged 5 commits into
nextfrom
norbert/remove-shim-addons
Jun 10, 2025
Merged

Core: Delete shim addon packages#31728
ndelangen merged 5 commits into
nextfrom
norbert/remove-shim-addons

Conversation

@ndelangen
Copy link
Copy Markdown
Member

@ndelangen ndelangen commented Jun 10, 2025

What I did

I deleted the shim packages for addons from the monorepo.

Because they have 0 dependencies, and all they do is cause an error/warning to happen.. there's no reason for these packages to ever change anymore.

Publishing the same code over and over again is a waste.

Furthermore, we want to actually mark these packages as deprecated on the npm registry. We cannot do that effectively if we keep publishing new versions.

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

Removes deprecated shim addon packages from the Storybook monorepo as part of the v9.0 consolidation effort.

  • Removes shim packages for actions, backgrounds, controls, measure, outline, toolbars, and viewport addons that only served to display deprecation warnings
  • Enables proper deprecation marking of these packages on npm registry by stopping continuous republishing
  • Aligns with v9.0 migration where these addons are now accessed directly from the core package (e.g., storybook/viewport instead of @storybook/addon-viewport)
  • Reduces maintenance overhead by removing redundant packages with zero dependencies
  • Supports cleaner migration path by leveraging npm's built-in deprecation mechanism

@ndelangen ndelangen changed the title delete shim packages Build: Delete shim addon packages Jun 10, 2025
@ndelangen ndelangen self-assigned this Jun 10, 2025
@ndelangen ndelangen added maintenance User-facing maintenance tasks addon: actions addon: viewport addon: backgrounds patch:yes Bugfix & documentation PR that need to be picked to main branch addon: toolbars addon: controls addon: interactions addon: outline addon: measure ci:normal Run our default set of CI jobs (choose this for most PRs). labels Jun 10, 2025
@ndelangen ndelangen marked this pull request as ready for review June 10, 2025 12:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Removes deprecated shim packages for the controls, backgrounds, and actions addons to stop re-publishing unused stubs.

  • Deletes entire directories and files for shimmed addons (package.json, source stubs, configs)
  • Eliminates the error stubs that provided migration guidance upon import
  • Cleans up build/preview/manager entry points for these addons

Reviewed Changes

Copilot reviewed 63 out of 63 changed files in this pull request and generated no comments.

File Description
code/addons/controls/** All shim package files removed
code/addons/backgrounds/** All shim package files removed
code/addons/actions/** All shim package files removed
Comments suppressed due to low confidence (1)

code/addons/backgrounds/src/error.ts:1

  • Removing these error stubs will cause users who still import the old addon to see a generic module-not-found error instead of a clear migration message. Consider keeping a minimal stub that throws a descriptive error pointing to the migration guide.
throw new Error(

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.

LGTM

63 files reviewed, no comments
Edit PR Review Bot Settings | Greptile

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Jun 10, 2025

View your CI Pipeline Execution ↗ for commit dac6a1a.

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

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

@shilman shilman changed the title Build: Delete shim addon packages Core: Delete shim addon packages Jun 10, 2025
Copy link
Copy Markdown
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Woohoo!!!

@ndelangen ndelangen merged commit 8f2c0db into next Jun 10, 2025
57 checks passed
@ndelangen ndelangen deleted the norbert/remove-shim-addons branch June 10, 2025 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addon: actions addon: backgrounds addon: controls addon: interactions addon: measure addon: outline addon: toolbars addon: viewport ci:normal Run our default set of CI jobs (choose this for most PRs). maintenance User-facing maintenance tasks patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants