Codemod: Add option to have relative path in csf factories codemod #30463
+108
−21
Conversation
This file contains 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
|
View your CI Pipeline Execution ↗ for commit 359ec9c.
☁️ Nx Cloud last updated this comment at |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
4 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
Comment on lines
133
to
+136
| t.isImportDeclaration(node) && | ||
| node.source.value === configImport.source.value && | ||
| !node.importKind | ||
| !t.isImportSpecifier(node) && | ||
| node.importKind !== 'type' && | ||
| node.source.value === configImport.source.value |
There was a problem hiding this comment.
logic: The check !t.isImportSpecifier(node) is redundant since isImportDeclaration(node) already implies this
Suggested change
| t.isImportDeclaration(node) && | |
| node.source.value === configImport.source.value && | |
| !node.importKind | |
| !t.isImportSpecifier(node) && | |
| node.importKind !== 'type' && | |
| node.source.value === configImport.source.value | |
| t.isImportDeclaration(node) && | |
| node.importKind !== 'type' && | |
| node.source.value === configImport.source.value |
Comment on lines
+59
to
+63
| const relativePath = relative(dirname(info.path), previewConfigPath) | ||
| // Convert Windows backslashes to forward slashes if present | ||
| .replace(/\\/g, '/') | ||
| // Remove .ts or .js extension | ||
| .replace(/\.(ts|js)x?$/, ''); |
There was a problem hiding this comment.
logic: Path calculation could fail if previewConfigPath is not absolute. Consider using path.resolve() to ensure absolute paths.
| dryRun, | ||
| packageManager, | ||
| useSubPathImports, | ||
| previewConfigPath: previewConfigPath!, |
There was a problem hiding this comment.
logic: non-null assertion on previewConfigPath could cause runtime errors if undefined
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #
What I did
This PR introduces a new prompt for the user related to the csf factories codemod.
When using the subpath imports, things may not work if users if they:
So the codemod provides an option for the user to not use subpath imports, and just get relative imports instead in the story files
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: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
Based on the provided information, I'll create a concise summary of the key changes in this PR:
Added user prompt and relative path import option to the CSF factories codemod, providing flexibility in how preview configs are imported in stories.
useSubPathImportsoption instoryToCsfFactoryto support both subpath (#.storybook/preview) and relative path importsstory-to-csf-factory.tsto handle relative paths from story files to preview configpackage.jsononly when subpath imports are chosenconfig-to-csf-factory.tsto prevent re-transformation of already converted code