Skip to content

Core: Improve addon detection in automigrations on windows #31937

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

Merged

Conversation

mrginglymus
Copy link
Contributor

@mrginglymus mrginglymus commented Jul 2, 2025

Addon detection is done by sniffing the value returned by getAddonNames, which pulls values from storybook config.

However, the wrap-require automation wraps addon references in an absolute path resolver.

On windows this means that addons are now reported as e.g. @storybook\\addon-a11y, which defeats detection

Closes #31936

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>

Greptile Summary

Fixed addon detection in Storybook automigrations for Windows environments by normalizing path separators.

  • Modified code/core/src/common/utils/get-addon-names.ts to handle Windows-style backslash path separators
  • Fixed issue where addons like @storybook\addon-a11y weren't being properly detected on Windows
  • Ensures consistent addon path handling across different operating systems
  • Maintains compatibility with the wrap-require automation system

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 reviewed, no comments
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Jul 2, 2025

View your CI Pipeline Execution ↗ for commit e0e4a3d

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

☁️ Nx Cloud last updated this comment at 2025-07-08 20:35:15 UTC

@mrginglymus
Copy link
Contributor Author

Whoops, didn't actually fix getAddonNames correctly. the addonA11yAddonTest checks has

const hasA11yAddon = !!addons.find((addon) => addon.includes('@storybook/addon-a11y'));

which threw me off. It presumably should be

const hasA11yAddon = addons.includes('@storybook/addon-a11y');

Addon detection is done by sniffing the value returned by getAddonNames,
which pulls values from storybook config.

However, the wrap-require automation wraps addon references in an
absolute path resolver.

On windows this means that addons are now reported as e.g.
@storybook\\addon-a11y, which defeats detection
@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Jul 8, 2025

Package Benchmarks

Commit: e0e4a3d, ran on 11 August 2025 at 11:40:59 UTC

The following packages have significant changes to their size or dependencies:

@storybook/addon-docs

Before After Difference
Dependency count 12 12 0
Self size 2.47 MB 2.42 MB 🎉 -53 KB 🎉
Dependency size 8.93 MB 8.93 MB 🚨 +1 B 🚨
Bundle Size Analyzer Link Link

storybook

Before After Difference
Dependency count 51 46 🎉 -5 🎉
Self size 41.74 MB 31.73 MB 🎉 -10.00 MB 🎉
Dependency size 18.13 MB 17.37 MB 🎉 -762 KB 🎉
Bundle Size Analyzer Link Link

@storybook/react-native-web-vite

Before After Difference
Dependency count 163 161 🎉 -2 🎉
Self size 32 KB 35 KB 🚨 +3 KB 🚨
Dependency size 23.68 MB 23.62 MB 🎉 -62 KB 🎉
Bundle Size Analyzer Link Link

@storybook/vue3-vite

Before After Difference
Dependency count 105 104 🎉 -1 🎉
Self size 34 KB 34 KB 0 B
Dependency size 43.55 MB 43.49 MB 🎉 -51 KB 🎉
Bundle Size Analyzer Link Link

sb

Before After Difference
Dependency count 52 47 🎉 -5 🎉
Self size 1 KB 1 KB 0 B
Dependency size 59.87 MB 49.10 MB 🎉 -10.77 MB 🎉
Bundle Size Analyzer Link Link

@storybook/cli

Before After Difference
Dependency count 220 216 🎉 -4 🎉
Self size 585 KB 582 KB 🎉 -3 KB 🎉
Dependency size 104.37 MB 93.68 MB 🎉 -10.69 MB 🎉
Bundle Size Analyzer Link Link

@storybook/codemod

Before After Difference
Dependency count 189 185 🎉 -4 🎉
Self size 31 KB 31 KB 0 B
Dependency size 88.45 MB 77.77 MB 🎉 -10.68 MB 🎉
Bundle Size Analyzer Link Link

create-storybook

Before After Difference
Dependency count 1 1 0
Self size 12.52 MB 12.50 MB 🎉 -15 KB 🎉
Dependency size 98 KB 98 KB 0 B
Bundle Size Analyzer Link Link

@github-actions github-actions bot added the Stale label Jul 24, 2025
@valentinpalkovic valentinpalkovic changed the title fix: addon detection in automigrations on windows Core: Improve addon detection in automigrations on windows Aug 11, 2025
@valentinpalkovic valentinpalkovic merged commit 70fff63 into storybookjs:next Aug 11, 2025
50 of 52 checks passed
@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Aug 11, 2025
yannbf pushed a commit that referenced this pull request Aug 11, 2025
Core: Improve addon detection in automigrations on windows
(cherry picked from commit 70fff63)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automigrations 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 Stale windows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: automigrations may not work on windows
2 participants