tailwindcss/integrations/vite/other-transforms.test.ts
Philipp Spiess b38948337d
Make @reference emit variable fallbacks instead of CSS variable declarations (#16774)
Fixes #16725

When using `@reference "tailwindcss";` inside a separate CSS root (e.g.
Svelte `<style>` components, CSS modules, etc.), we have no guarantee
that the CSS variables will be defined in the main stylesheet (or if
there even is one). To work around potential issues with this we decided
in #16676 that we would emit all used CSS variables from the `@theme`
inside the `@reference` block.

However, this is not only a bit surprising but also unexpected in CSS
modules and Next.js that **requires CSS module files to only create
scope-able declarations**. To fix this issue, we decided to not emit CSS
variables but instead ensure all `var(…)` calls we create for theme
values in reference mode will simply have their fallback value added.

This ensures styles work as-expected even if the root Tailwind file does
not pick up the variable as being used or _if you don't add a root at
all_. Furthermore we do not duplicate any variable declarations across
your stylesheets and you still have the ability to change variables at
runtime.

## Test plan

- Updated snapshots everywhere (see diff)
- New Next.js CSS modules integration test
2025-02-25 11:36:43 +01:00

179 lines
4.5 KiB
TypeScript

import dedent from 'dedent'
import { describe } from 'vitest'
import { css, fetchStyles, html, retryAssertion, test, ts, txt } from '../utils'
function createSetup(transformer: 'postcss' | 'lightningcss') {
return {
fs: {
'package.json': txt`
{
"type": "module",
"dependencies": {
"@tailwindcss/vite": "workspace:^",
"tailwindcss": "workspace:^"
},
"devDependencies": {
${transformer === 'lightningcss' ? `"lightningcss": "^1.26.0",` : ''}
"vite": "^6"
}
}
`,
'vite.config.ts': ts`
import tailwindcss from '@tailwindcss/vite'
import { defineConfig } from 'vite'
export default defineConfig({
css: ${transformer === 'postcss' ? '{}' : "{ transformer: 'lightningcss' }"},
build: { cssMinify: false },
plugins: [
tailwindcss(),
{
name: 'recolor',
transform(code, id) {
if (id.includes('.css')) {
return code.replace(/red;/g, 'blue;')
}
},
},
],
})
`,
'index.html': html`
<head>
<link rel="stylesheet" href="./src/index.css" />
</head>
<body>
<div class="foo [background-color:red]">Hello, world!</div>
</body>
`,
'src/index.css': css`
@reference 'tailwindcss/theme';
@import 'tailwindcss/utilities';
.foo {
color: red;
}
`,
},
}
}
describe.each(['postcss', 'lightningcss'] as const)('%s', (transformer) => {
test(`production build`, createSetup(transformer), async ({ fs, exec, expect }) => {
await exec('pnpm vite build')
let files = await fs.glob('dist/**/*.css')
expect(files).toHaveLength(1)
let [filename] = files[0]
await fs.expectFileToContain(filename, [
css`
.foo {
color: blue;
}
`,
// Running the transforms on utilities generated by Tailwind might change in the future
dedent`
.\[background-color\:red\] {
background-color: blue;
}
`,
])
})
test('dev mode', createSetup(transformer), async ({ spawn, fs, expect }) => {
let process = await spawn('pnpm vite dev')
await process.onStdout((m) => m.includes('ready in'))
let url = ''
await process.onStdout((m) => {
let match = /Local:\s*(http.*)\//.exec(m)
if (match) url = match[1]
return Boolean(url)
})
await retryAssertion(async () => {
let styles = await fetchStyles(url, '/index.html')
expect(styles).toContain(css`
.foo {
color: blue;
}
`)
// Running the transforms on utilities generated by Tailwind might change in the future
expect(styles).toContain(dedent`
.\[background-color\:red\] {
background-color: blue;
}
`)
})
await retryAssertion(async () => {
await fs.write(
'src/index.css',
css`
@reference 'tailwindcss/theme';
@import 'tailwindcss/utilities';
.foo {
background-color: red;
}
`,
)
let styles = await fetchStyles(url)
expect(styles).toContain(css`
.foo {
background-color: blue;
}
`)
})
})
test('watch mode', createSetup(transformer), async ({ spawn, fs, expect }) => {
let process = await spawn('pnpm vite build --watch')
await process.onStdout((m) => m.includes('built in'))
await retryAssertion(async () => {
let files = await fs.glob('dist/**/*.css')
expect(files).toHaveLength(1)
let [, styles] = files[0]
expect(styles).toContain(css`
.foo {
color: blue;
}
`)
// Running the transforms on utilities generated by Tailwind might change in the future
expect(styles).toContain(dedent`
.\[background-color\:red\] {
background-color: blue;
}
`)
})
await retryAssertion(async () => {
await fs.write(
'src/index.css',
css`
@reference 'tailwindcss/theme';
@import 'tailwindcss/utilities';
.foo {
background-color: red;
}
`,
)
let files = await fs.glob('dist/**/*.css')
expect(files).toHaveLength(1)
let [, styles] = files[0]
expect(styles).toContain(css`
.foo {
background-color: blue;
}
`)
})
})
})