-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
fix: 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
base: next
Are you sure you want to change the base?
fix: addon detection in automigrations on windows #31937
Conversation
There was a problem hiding this 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
View your CI Pipeline Execution ↗ for commit e0e4a3d
☁️ Nx Cloud last updated this comment at |
Whoops, didn't actually fix getAddonNames correctly. the
which threw me off. It presumably should be
|
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
fc9df9b
to
860f5fb
Compare
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
Before | After | Difference | |
---|---|---|---|
Dependency count | 217 | 217 | 0 |
Self size | 582 KB | 582 KB | 0 B |
Dependency size | 94.81 MB | 93.66 MB | 🎉 -1.16 MB 🎉 |
Bundle Size Analyzer | Link | Link |
@storybook/codemod
Before | After | Difference | |
---|---|---|---|
Dependency count | 186 | 186 | 0 |
Self size | 31 KB | 31 KB | 0 B |
Dependency size | 78.91 MB | 77.76 MB | 🎉 -1.16 MB 🎉 |
Bundle Size Analyzer | Link | Link |
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 detectionCloses #31936
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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.
code/core/src/common/utils/get-addon-names.ts
to handle Windows-style backslash path separators@storybook\addon-a11y
weren't being properly detected on Windows