Skip to content
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

Throw when layer(…) in @import is in the incorrect spot #15109

Merged
merged 8 commits into from
Nov 27, 2024
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 @@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed

- Interpolate gradients using OKLAB instead of OKLCH by default ([#15201](https://github.com/tailwindlabs/tailwindcss/pull/15201))
- Error when `layer(…)` in `@import` is not first in the list of functions/conditions ([#15109](https://github.com/tailwindlabs/tailwindcss/pull/15109))

## [4.0.0-beta.2] - 2024-11-22

Expand Down
105 changes: 56 additions & 49 deletions packages/tailwindcss/src/at-import.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,47 @@ export async function substituteAtImports(

walk(ast, (node, { replaceWith }) => {
if (node.kind === 'at-rule' && node.name === '@import') {
try {
let { uri, layer, media, supports } = parseImportParams(ValueParser.parse(node.params))

// Skip importing data or remote URIs
if (uri.startsWith('data:')) return
if (uri.startsWith('http://') || uri.startsWith('https://')) return

let contextNode = context({}, [])

promises.push(
(async () => {
// Since we do not have fully resolved paths in core, we can't reliably detect circular
// imports. Instead, we try to limit the recursion depth to a number that is too large
// to be reached in practice.
if (recurseCount > 100) {
throw new Error(
`Exceeded maximum recursion depth while resolving \`${uri}\` in \`${base}\`)`,
)
}

const loaded = await loadStylesheet(uri, base)
let ast = CSS.parse(loaded.content)
await substituteAtImports(ast, loaded.base, loadStylesheet, recurseCount + 1)

contextNode.nodes = buildImportNodes(
[context({ base: loaded.base }, ast)],
layer,
media,
supports,
let parsed = parseImportParams(ValueParser.parse(node.params))
if (parsed === null) return

let { uri, layer, media, supports } = parsed

// Skip importing data or remote URIs
if (uri.startsWith('data:')) return
if (uri.startsWith('http://') || uri.startsWith('https://')) return

let contextNode = context({}, [])

promises.push(
(async () => {
// Since we do not have fully resolved paths in core, we can't
// reliably detect circular imports. Instead, we try to limit the
// recursion depth to a number that is too large to be reached in
// practice.
if (recurseCount > 100) {
throw new Error(
`Exceeded maximum recursion depth while resolving \`${uri}\` in \`${base}\`)`,
)
})(),
)

replaceWith(contextNode)
// The resolved Stylesheets already have their transitive @imports
// resolved, so we can skip walking them.
return WalkAction.Skip
} catch (e: any) {
// When an error occurs while parsing the `@import` statement, we skip
// the import.
}
}

let loaded = await loadStylesheet(uri, base)
let ast = CSS.parse(loaded.content)
await substituteAtImports(ast, loaded.base, loadStylesheet, recurseCount + 1)

contextNode.nodes = buildImportNodes(
[context({ base: loaded.base }, ast)],
layer,
media,
supports,
)
})(),
)

replaceWith(contextNode)

// The resolved Stylesheets already have their transitive @imports
// resolved, so we can skip walking them.
return WalkAction.Skip
}
})

Expand All @@ -72,30 +72,37 @@ export function parseImportParams(params: ValueParser.ValueAstNode[]) {
let supports: string | null = null

for (let i = 0; i < params.length; i++) {
const node = params[i]
let node = params[i]

if (node.kind === 'separator') continue

if (node.kind === 'word' && !uri) {
if (!node.value) throw new Error(`Unable to find uri`)
if (node.value[0] !== '"' && node.value[0] !== "'") throw new Error('Unable to find uri')
if (!node.value) return null
if (node.value[0] !== '"' && node.value[0] !== "'") return null

uri = node.value.slice(1, -1)
continue
}

if (node.kind === 'function' && node.value.toLowerCase() === 'url') {
throw new Error('`url(…)` functions are not supported')
// `@import` with `url(…)` functions are not inlined but skipped and kept
// in the final CSS instead.
// E.g.: `@import url("https://fonts.google.com")`
return null
}

if (!uri) throw new Error('Unable to find uri')
if (!uri) return null

if (
(node.kind === 'word' || node.kind === 'function') &&
node.value.toLowerCase() === 'layer'
) {
if (layer) throw new Error('Multiple layers')
if (supports) throw new Error('`layer(…)` must be defined before `supports(…)` conditions')
if (layer) return null
if (supports) {
throw new Error(
'`layer(…)` in an `@import` should come before any other functions or conditions',
)
}

if ('nodes' in node) {
layer = ValueParser.toCss(node.nodes)
Expand All @@ -107,7 +114,7 @@ export function parseImportParams(params: ValueParser.ValueAstNode[]) {
}

if (node.kind === 'function' && node.value.toLowerCase() === 'supports') {
if (supports) throw new Error('Multiple support conditions')
if (supports) return null
supports = ValueParser.toCss(node.nodes)
continue
}
Expand All @@ -116,7 +123,7 @@ export function parseImportParams(params: ValueParser.ValueAstNode[]) {
break
}

if (!uri) throw new Error('Unable to find uri')
if (!uri) return null

return { uri, layer, media, supports }
}
Expand Down
25 changes: 25 additions & 0 deletions packages/tailwindcss/src/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3063,3 +3063,28 @@ test('addBase', async () => {
}"
`)
})

it("should error when `layer(…)` is used, but it's not the first param", async () => {
expect(async () => {
return await compileCss(
css`
@import './bar.css' supports(display: grid) layer(utilities);
`,
[],
{
async loadStylesheet() {
return {
base: '/bar.css',
content: css`
.foo {
@apply underline;
}
`,
}
},
},
)
}).rejects.toThrowErrorMatchingInlineSnapshot(
`[Error: \`layer(…)\` in an \`@import\` should come before any other functions or conditions]`,
)
})