Vite: Fix wrong import paths when configDir is not in project root#30206
Merged
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 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
4 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
+32
to
+34
| export async function toImportFn(stories: string[]) { | ||
| const objectEntries = stories.map((file) => { | ||
| const relativePath = relative(root, file); | ||
| const relativePath = relative(process.cwd(), file); |
Contributor
There was a problem hiding this comment.
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().
valentinpalkovic
approved these changes
Jan 7, 2025
tobiasdiez
reviewed
Jan 7, 2025
Contributor
tobiasdiez
left a comment
tobiasdiez
left a comment
There was a problem hiding this comment.
One small suggestion, otherwise lgtm. Thanks for the fix!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
projectRootwas 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
.storybookdirectory to a nested one, eg. todeeply/nested/.storybook.storiesglob inmain.tsto be correctly relative to the new locationstorybookscript inpackage.jsonto point to the new directory with the flag-c deeply/nested/.storybookThis 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:mergedorci:dailyGH 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.tsMake 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/coreteam 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.
projectRootparameter fromtoImportFnincode/builders/builder-vite/src/codegen-importfn-script.tsto useprocess.cwd()consistentlycodegen-importfn-script.test.tsto mockprocess.cwd()instead of passing root parameter@fs#28941 invite-config.tsto restore correct path resolution behaviorprojectRootproperty fromBuilderOptionsinterface incore-common.ts