Skip to content

Don’t replace _ in suggested theme keys #16433

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 3 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Export `tailwindcss/lib/util/flattenColorPalette.js` for backward compatibility ([#16411](https://github.com/tailwindlabs/tailwindcss/pull/16411))
- Fix sorting numeric utilities when they have different magnitudes ([#16414](https://github.com/tailwindlabs/tailwindcss/pull/16414))
- Show suggestions for fractions in IntelliSense ([#16353](https://github.com/tailwindlabs/tailwindcss/pull/16353))
- Don’t replace `_` in suggested theme keys ([#16433](https://github.com/tailwindlabs/tailwindcss/pull/16433))

## [4.0.6] - 2025-02-10

Expand Down
37 changes: 37 additions & 0 deletions packages/tailwindcss/src/intellisense.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -526,3 +526,40 @@ test('Custom functional @utility', async () => {
expect(classNames).toContain('example-xs')
expect(classMap.get('example-xs')?.modifiers).toEqual(['foo', 'bar'])
})

test('Theme keys with underscores are suggested with underscores', async () => {
let input = css`
@import 'tailwindcss/utilities';

@theme {
/* Disable the spacing scale */
--spacing: initial;

/* This will get suggeted with a dot because its surrounded by numbers */
--spacing-1_5: 1.5rem;

/* This will get suggeted with a dot */
--spacing-2\.5: 1.5rem;

/* This will get suggeted with an underscore */
--spacing-logo_margin: 0.875rem;
}
`

let design = await __unstable__loadDesignSystem(input, {
loadStylesheet: async (_, base) => ({
base,
content: '@tailwind utilities;',
}),
})

let entries = design.getClassList().filter(([name]) => name.startsWith('p-'))

expect(entries).toContainEqual(['p-1.5', { modifiers: [] }])
expect(entries).toContainEqual(['p-2.5', { modifiers: [] }])
expect(entries).toContainEqual(['p-logo_margin', { modifiers: [] }])

expect(entries).not.toContainEqual(['p-1_5', { modifiers: [] }])
expect(entries).not.toContainEqual(['p-2_5', { modifiers: [] }])
expect(entries).not.toContainEqual(['p-logo.margin', { modifiers: [] }])
})
13 changes: 12 additions & 1 deletion packages/tailwindcss/src/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,20 @@ export function createUtilities(theme: Theme) {
* Register list of suggestions for a class
*/
function suggest(classRoot: string, defns: () => SuggestionDefinition[]) {
/**
* The alpha and beta releases used `_` in theme keys to represent a `.`. This meant we used
* `--leading-1_5` instead of `--leading-1\.5` to add utilities like `leading-1.5`.
*
* We prefer the use of the escaped dot now but still want to make sure suggestions for the
* legacy key format still works as expected when surrounded by numbers.
*/
const LEGACY_NUMERIC_KEY = /(\d+)_(\d+)/g

function* resolve(themeKeys: ThemeKey[]) {
for (let value of theme.keysInNamespaces(themeKeys)) {
yield value.replaceAll('_', '.')
yield value.replace(LEGACY_NUMERIC_KEY, (_, a, b) => {
return `${a}.${b}`
})
}
}

Expand Down