-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Change casing of utilities with named values to kebab-case to match u… #18017
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
24 changes: 24 additions & 0 deletions
24
packages/@tailwindcss-upgrade/src/codemods/template/migrate-camelcase-in-named-value.test.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import { __unstable__loadDesignSystem } from '@tailwindcss/node' | ||
| import { expect, test, vi } from 'vitest' | ||
| import * as versions from '../../utils/version' | ||
| import { migrateCamelcaseInNamedValue } from './migrate-camelcase-in-named-value' | ||
| vi.spyOn(versions, 'isMajor').mockReturnValue(true) | ||
|
|
||
| test.each([ | ||
| ['text-superRed', 'text-super-red'], | ||
| ['text-red/superOpaque', 'text-red/super-opaque'], | ||
| ['text-superRed/superOpaque', 'text-super-red/super-opaque'], | ||
|
|
||
| // Should not migrate named values in modifiers | ||
| ['group-hover/superGroup:underline', 'group-hover/superGroup:underline'], | ||
|
|
||
| ['hover:text-superRed', 'hover:text-super-red'], | ||
| ['hover:text-red/superOpaque', 'hover:text-red/super-opaque'], | ||
| ['hover:text-superRed/superOpaque', 'hover:text-super-red/super-opaque'], | ||
| ])('%s => %s', async (candidate, result) => { | ||
| let designSystem = await __unstable__loadDesignSystem('@import "tailwindcss";', { | ||
| base: __dirname, | ||
| }) | ||
|
|
||
| expect(migrateCamelcaseInNamedValue(designSystem, {}, candidate)).toEqual(result) | ||
| }) |
53 changes: 53 additions & 0 deletions
53
packages/@tailwindcss-upgrade/src/codemods/template/migrate-camelcase-in-named-value.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import type { Config } from '../../../../tailwindcss/src/compat/plugin-api' | ||
| import type { DesignSystem } from '../../../../tailwindcss/src/design-system' | ||
| import * as version from '../../utils/version' | ||
|
|
||
| // Converts named values to use kebab-case. This is necessary because the | ||
| // upgrade tool also renames the theme values to kebab-case, so `text-superRed` | ||
| // will have its theme value renamed to `--color-super-red` and thus the utility | ||
| // will be renamed to `text-super-red`. | ||
| export function migrateCamelcaseInNamedValue( | ||
| designSystem: DesignSystem, | ||
| _userConfig: Config | null, | ||
| rawCandidate: string, | ||
| ): string { | ||
| if (!version.isMajor(3)) return rawCandidate | ||
|
|
||
| for (let candidate of designSystem.parseCandidate(rawCandidate)) { | ||
| if (candidate.kind !== 'functional') continue | ||
| let clone = structuredClone(candidate) | ||
| let didChange = false | ||
|
|
||
| if ( | ||
| candidate.value && | ||
| clone.value && | ||
| candidate.value.kind === 'named' && | ||
| clone.value.kind === 'named' && | ||
| candidate.value.value.match(/[A-Z]/) | ||
| ) { | ||
| clone.value.value = camelToKebab(candidate.value.value) | ||
| didChange = true | ||
| } | ||
|
|
||
| if ( | ||
| candidate.modifier && | ||
| clone.modifier && | ||
| candidate.modifier.kind === 'named' && | ||
| clone.modifier.kind === 'named' && | ||
| candidate.modifier.value.match(/[A-Z]/) | ||
| ) { | ||
| clone.modifier.value = camelToKebab(candidate.modifier.value) | ||
| didChange = true | ||
| } | ||
|
|
||
| if (didChange) { | ||
| return designSystem.printCandidate(clone) | ||
| } | ||
| } | ||
|
|
||
| return rawCandidate | ||
| } | ||
|
|
||
| function camelToKebab(str: string): string { | ||
| return str.replace(/([A-Z])/g, '-$1').toLowerCase() | ||
| } |
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
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.
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.
Can we also add a test to ensure that a named modifier is actually converted to kebab-case as well?