Skip to content

Fix purge of CSS variables in at-rules (media & supports) #1492

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.

Sign up for GitHub

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

Open
vsn4ik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix purge of CSS variables in at-rules (media & supports) #1492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 45 additions & 0 deletions packages/purgecss/__tests__/media-queries-variables.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { PurgeCSS, type ResultPurge } from "./../src/index";
import { ROOT_TEST_EXAMPLES } from "./utils";

describe("media queries variables", () => {
let purgecssResult: ResultPurge;
beforeAll(async () => {
const purgecss = await new PurgeCSS().purge({
content: [
`${ROOT_TEST_EXAMPLES}media-queries-variables/media_queries_variables.html`,
],
css: [
`${ROOT_TEST_EXAMPLES}media-queries-variables/media_queries_variables.css`,
],
variables: true,
rejected: true,
rejectedCss: true,
});
purgecssResult = purgecss[0];
});

it("keeps '--font-size-*'", () => {
expect(purgecssResult.css).toContain("--font-size-1:");
expect(purgecssResult.css).toContain("--font-size-2:");
expect(purgecssResult.css).toContain("--font-size-3:");
});

it("removes '--unused-font-size-*'", () => {
expect(purgecssResult.rejectedCss).toContain("--unused-font-size-1");
expect(purgecssResult.rejectedCss).toContain("--unused-font-size-2");
expect(purgecssResult.css).not.toContain("--unused-font-size-1");
expect(purgecssResult.css).not.toContain("--unused-font-size-2");
});

it("finds .used-class-*", () => {
expect(purgecssResult.css).toContain(".used-class-1");
expect(purgecssResult.css).toContain(".used-class-2");
});

it("removes .unused-class-*", () => {
expect(purgecssResult.rejected).toContain(".unused-class-1");
expect(purgecssResult.rejected).toContain(".unused-class-2");
expect(purgecssResult.css).not.toContain(".unused-class-1");
expect(purgecssResult.css).not.toContain(".unused-class-2");
});
});
43 changes: 43 additions & 0 deletions packages/purgecss/__tests__/supports-variables.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { PurgeCSS, type ResultPurge } from "./../src/index";
import { ROOT_TEST_EXAMPLES } from "./utils";

describe("supports variables", () => {
let purgecssResult: ResultPurge;
beforeAll(async () => {
const purgecss = await new PurgeCSS().purge({
content: [
`${ROOT_TEST_EXAMPLES}supports-variables/supports_variables.html`,
],
css: [`${ROOT_TEST_EXAMPLES}supports-variables/supports_variables.css`],
variables: true,
rejected: true,
rejectedCss: true,
});
purgecssResult = purgecss[0];
});

it("keeps '--font-size-*'", () => {
expect(purgecssResult.css).toContain("--font-size-1:");
expect(purgecssResult.css).toContain("--font-size-2:");
expect(purgecssResult.css).toContain("--font-size-3:");
});

it("removes '--unused-font-size-*'", () => {
expect(purgecssResult.rejectedCss).toContain("--unused-font-size-1");
expect(purgecssResult.rejectedCss).toContain("--unused-font-size-2");
expect(purgecssResult.css).not.toContain("--unused-font-size-1");
expect(purgecssResult.css).not.toContain("--unused-font-size-2");
});

it("finds .used-class-*", () => {
expect(purgecssResult.css).toContain(".used-class-1");
expect(purgecssResult.css).toContain(".used-class-2");
});

it("removes .unused-class-*", () => {
expect(purgecssResult.rejected).toContain(".unused-class-1");
expect(purgecssResult.rejected).toContain(".unused-class-2");
expect(purgecssResult.css).not.toContain(".unused-class-1");
expect(purgecssResult.css).not.toContain(".unused-class-2");
});
});
31 changes: 31 additions & 0 deletions ...ages/purgecss/__tests__/test_examples/media-queries-variables/media_queries_variables.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:root {
--font-size-1: 1.5rem;
--font-size-2: 1.5rem;
--font-size-3: 1.5rem;
--unused-font-size-1: 1.5rem;
--unused-font-size-2: 1.5rem;
}

.used-class-1 {
.used-class-2 {
font-size: var(--font-size-1);
}

.unused-class-1 {
font-size: var(--unused-font-size-1);
}

@media (max-width: 768px) {
font-size: var(--font-size-2);

.used-class-3 {
@media (min-width: 576px) {
font-size: var(--font-size-3);
}
}

.unused-class-2 {
font-size: var(--unused-font-size-2);
}
}
}
4 changes: 4 additions & 0 deletions ...ges/purgecss/__tests__/test_examples/media-queries-variables/media_queries_variables.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div class="used-class-1">
<span class="used-class-2">span 1</span>
<span class="used-class-3">span 2</span>
</div>
31 changes: 31 additions & 0 deletions packages/purgecss/__tests__/test_examples/supports-variables/supports_variables.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:root {
--font-size-1: 1.5rem;
--font-size-2: 1.5rem;
--font-size-3: 1.5rem;
--unused-font-size-1: 1.5rem;
--unused-font-size-2: 1.5rem;
}

.used-class-1 {
.used-class-2 {
font-size: var(--font-size-1);
}

.unused-class-1 {
font-size: var(--unused-font-size-1);
}

@supports (display: grid) {
font-size: var(--font-size-2);

.used-class-3 {
@supports (backdrop-filter: blur(10px)) {
font-size: var(--font-size-3);
}
}

.unused-class-2 {
font-size: var(--unused-font-size-2);
}
}
}
4 changes: 4 additions & 0 deletions packages/purgecss/__tests__/test_examples/supports-variables/supports_variables.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<div class="used-class-1">
<span class="used-class-2">span 1</span>
<span class="used-class-3">span 2</span>
</div>
15 changes: 14 additions & 1 deletion packages/purgecss/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,19 @@ class PurgeCSS {
* @param node - node of postcss AST
*/
private evaluateAtRule(node: postcss.AtRule): void {
// when tracking variables, collect var() usages from declarations
// nested inside at-rules (e.g. @media, @supports, ...)
if (
this.options.variables &&
(node.name === "media" || node.name === "supports") &&
node.nodes
) {
for (const childNode of node.nodes) {
if (childNode.type !== "decl") continue;
this.collectDeclarationsData(childNode);
}
}

// keyframes
if (this.options.keyframes && node.name.endsWith("keyframes")) {
this.atRules.keyframes.push(node);
Expand Down Expand Up @@ -615,7 +628,7 @@ class PurgeCSS {
}).processSync(node.selector);

// declarations
if (node.selector && typeof node.nodes !== "undefined") {
if (node.selector && node.nodes) {
for (const childNode of node.nodes) {
if (childNode.type !== "decl") continue;
this.collectDeclarationsData(childNode);
Expand Down