Codemod: Only remove types when they are unused #30644
Conversation
![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
| expect.addSnapshotSerializer({ | ||
| serialize: (val: any) => { | ||
| if (typeof val === 'string') { | ||
| return val; | ||
| } | ||
| if (typeof val === 'object' && val !== null) { | ||
| return JSON.stringify(val, null, 2); | ||
| } | ||
| return String(val); | ||
| }, | ||
| test: (_val) => true, | ||
| }); |
There was a problem hiding this comment.
style: Custom serializer always returns true for test() which may cause unexpected serialization of values. Consider adding more specific type checking.
| const programNode = parseCodeToProgramNode(code); | ||
| const cleanedNodes = cleanupTypeImports(programNode, ['Preview']); | ||
|
|
There was a problem hiding this comment.
logic: Test case uses 'Preview' in disallowList but the import is a namespace import which wouldn't contain 'Preview' directly. Consider using a more relevant test case.
| return !disallowList.includes(specifier.imported.name); | ||
| const name = specifier.imported.name; | ||
| // Only remove if disallowed AND unused | ||
| return !disallowList.includes(name) || usedIdentifiers.has(name); |
There was a problem hiding this comment.
logic: The OR condition here means a type will be kept if it's used, even if disallowed. Verify this is the intended behavior.
|
View your CI Pipeline Execution ↗ for commit 694948c.
☁️ Nx Cloud last updated this comment at |
yannbf
added
the
patch:yes
…n-unused Codemod: Only remove types when they are unused (cherry picked from commit d5c5962)
github-actions
bot
added
the
patch:done
Closes #
What I did
This PR adds extra logic to type removal so that the AST is traversed first to check whether the types are being used.
Additionally it adds unit tests to functions which didn't have tests before.
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 this PR's changes focusing on the type management improvements in Storybook's codemod utilities.
Improved type import management in Storybook's codemod utilities by adding AST traversal to only remove unused type imports.
csf-factories-utils.test.tswith comprehensive test coverage for type import cleanup and export declarationscleanupTypeImportsincsf-factories-utils.tsto track used identifiers before removing importsstory-to-csf-factory.tsto check type usage before removal