-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Vite: Fix wrong import paths when configDir is not in project root #30206
Conversation
View your CI Pipeline Execution ↗ for commit c4542a2.
☁️ Nx Cloud last updated this comment at |
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.
4 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
export async function toImportFn(stories: string[]) { | ||
const objectEntries = stories.map((file) => { | ||
const relativePath = relative(root, file); | ||
const relativePath = relative(process.cwd(), file); |
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.
style: Removing the root parameter and hardcoding process.cwd() could make this function less flexible for future use cases where a different root directory is needed. Consider keeping the parameter but defaulting to process.cwd().
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.
One small suggestion, otherwise lgtm. Thanks for the fix!
Closes #30147
What I did
This PR fixes a regression in #28941, that caused import paths to be relative to the wrong directory if the config directory (aka
.storybook
) was not a direct child of the project root. The problem was originally discussed in #28941 (comment) but was unfortunately missed in the end.The idea of a custom
projectRoot
was good, but right now there are just a lot of implicit logic that depends on the path being relative to CWD, so the easiest fix was just to more or less revert c9107a1 .cc @tobiasdiez
I applied these changes to the reproduction provided in the original issue and confirmed they fix it.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
.storybook
directory to a nested one, eg. todeeply/nested/.storybook
.stories
glob inmain.ts
to be correctly relative to the new locationstorybook
script inpackage.json
to point to the new directory with the flag-c deeply/nested/.storybook
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
This PR fixes import path resolution in the Vite builder when the Storybook config directory is not in the project root.
projectRoot
parameter fromtoImportFn
incode/builders/builder-vite/src/codegen-importfn-script.ts
to useprocess.cwd()
consistentlycodegen-importfn-script.test.ts
to mockprocess.cwd()
instead of passing root parameter@fs
#28941 invite-config.ts
to restore correct path resolution behaviorprojectRoot
property fromBuilderOptions
interface incore-common.ts