fix(upgrade): don't migrate variant prop values in expressions or comments - #20535
Draft
Dextheking1 wants to merge 2 commits into
Draft
Dextheking1 wants to merge 2 commits into
Dextheking1 wants to merge 2 commits into
Conversation
…omments
The is-safe-migration guard for shadcn/ui `variant` props only looked at
the text immediately before the candidate, so a conditional between the
prop and the string (e.g. `variant={isActive ? "outline" : "ghost"}`)
defeated it and the codemod rewrote variant names like `outline` to
`outline-solid`. Scan the prop value as an expression instead, so strings
inside ternaries, `??`, and comparisons are left alone. Also skip
candidates inside `//` and `/* */` comments, which are prose, not classes.
Fixes tailwindlabs#20435.
…omments
The is-safe-migration guard for shadcn/ui `variant` props only looked at
the text immediately before the candidate, so a conditional between the
prop and the string (e.g. `variant={isActive ? "outline" : "ghost"}`)
defeated it and the codemod rewrote variant names like `outline` to
`outline-solid`. Scan the prop value as an expression instead, so strings
inside ternaries, `??`, and comparisons are left alone. Also skip
candidates inside `//` and `/* */` comments, which are prose, not classes.
Fixes tailwindlabs#20435.
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
1 participant
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.
Fixes #20435.
The
is-safe-migrationguard for shadcn/uivariantprops only looked at the text right before the candidate, so any conditional between the prop and the string defeated it.variant={isActive ? "outline" : "ghost"}hadoutlinerewritten tooutline-solid, breaking typed variant props loudly and untyped ones silently.The guard now scans the prop value as an expression: strings inside ternaries,
??, and comparisons are left alone, while a sibling prop after the variant value (e.g.className="outline") still migrates. Candidates inside//and/* */comments are skipped too; comment prose is not a class name.Verified: added 11 cases to
is-safe-migration.test.ts. 9 fail on pristine code, all 79 pass with the fix. Prettier clean.