Skip to content

feat(@angular-devkit/build-angular): tailwindcss purge #20036

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

Closed
wants to merge 1 commit into from
Closed

feat(@angular-devkit/build-angular): tailwindcss purge #20036

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
22 changes: 21 additions & 1 deletion packages/angular_devkit/build_angular/src/webpack/configs/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,27 @@ export function getStylesConfig(wco: WebpackConfigOptions) {
);
}
if (tailwindPackagePath) {
extraPostcssPlugins.push(require(tailwindPackagePath)({ config: tailwindConfigPath }));
const tailwindConfig = require(tailwindConfigPath);
if (typeof tailwindConfig !== 'function') {
if (!tailwindConfig.purge) {
tailwindConfig.purge = {};
}
if (Array.isArray(tailwindConfig.purge)) {
tailwindConfig.purge = {
content: [...tailwindConfig.purge],
};
}
if (typeof tailwindConfig.purge.enabled === 'undefined') {
tailwindConfig.purge.enabled = !!buildOptions.optimization?.styles.minify;
}

} else {
wco.logger.warn(
`Tailwind CSS configuration file export function instead of object.` +
` To enable Purge in Tailwind CSS, please make sure to export an object.`,
);
}
extraPostcssPlugins.push(require(tailwindPackagePath)(tailwindConfig));
}
}

Expand Down
72 changes: 63 additions & 9 deletions tests/legacy-cli/e2e/tests/build/styles/tailwind.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { deleteFile, expectFileToMatch, writeFile } from '../../../utils/fs';
import { deleteFile, expectFileToMatch, replaceInFile, writeFile } from '../../../utils/fs';
import { installPackage, uninstallPackage } from '../../../utils/packages';
import { ng, silentExec } from '../../../utils/process';
import { updateJsonFile } from '../../../utils/project';
import { expectToFail } from '../../../utils/utils';

export default async function () {
Expand All @@ -14,12 +15,18 @@ export default async function () {

// Create configuration file
await silentExec('npx', 'tailwindcss', 'init');
await replaceInFile('tailwind.config.js', `purge: [],`, `purge: ['./src/**/*.{html,ts}'],`);
await updateJsonFile('angular.json', json => {
json.projects['test-project'].architect.build.configurations.production.budgets = [
{ type: 'all', maximumError: '100mb' },
];
});

// Add Tailwind directives to a component style
await writeFile('src/app/app.component.css', '@tailwind base; @tailwind components;');
await writeFile('src/app/app.component.css', '@tailwind base; @tailwind components; @tailwind utilities');

// Add Tailwind directives to a global style
await writeFile('src/styles.css', '@tailwind base; @tailwind components;');
await writeFile('src/styles.css', '@tailwind base; @tailwind components; @tailwind utilities');

// Build should succeed and process Tailwind directives
await ng('build');
Expand All @@ -28,19 +35,66 @@ export default async function () {
await expectFileToMatch('dist/test-project/styles.css', /::placeholder/);
await expectFileToMatch('dist/test-project/main.js', /::placeholder/);
await expectToFail(() =>
expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components;'),
expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components; @tailwind utilities'),
);
await expectToFail(() =>
expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components;'),
expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components; @tailwind utilities'),
);


await writeFile('src/app/app.component.html', '<div class="py-2 px-4 rounded-md bg-red-400">Test</div>');
await ng('build', '--prod', '--output-hashing=none');
await expectFileToMatch('dist/test-project/styles.css', /\.rounded-md/);
await expectFileToMatch('dist/test-project/main.js', /\.rounded-md/);
await expectToFail(() =>
expectFileToMatch('dist/test-project/styles.css', /\.py-3/),
);
await expectToFail(() =>
expectFileToMatch('dist/test-project/main.js', /\.py-3/),
);
await replaceInFile('tailwind.config.js', `purge: ['./src/**/*.{html,ts}'],`, `purge: {
content: [
'./src/**/*.{html,ts}',
]
},`);
await ng('build', '--prod', '--output-hashing=none');
await expectFileToMatch('dist/test-project/styles.css', /\.rounded-md/);
await expectFileToMatch('dist/test-project/main.js', /\.rounded-md/);
await expectToFail(() =>
expectFileToMatch('dist/test-project/styles.css', /\.py-3/),
);
await expectToFail(() =>
expectFileToMatch('dist/test-project/main.js', /\.py-3/),
);

await replaceInFile('tailwind.config.js', `purge: {`, `purge: { enabled: false,`);
await ng('build', '--prod', '--output-hashing=none');
expectFileToMatch('dist/test-project/styles.css', /\.py-3/),
expectFileToMatch('dist/test-project/main.js', /\.py-3/),
await replaceInFile('tailwind.config.js', `purge: { enabled: false,`, `purge: { enabled: true,`);
await ng('build');
await expectToFail(() =>
expectFileToMatch('dist/test-project/styles.css', /\.py-3/),
);
await expectToFail(() =>
expectFileToMatch('dist/test-project/main.js', /\.py-3/),
);


await writeFile('tailwind.config.js', 'module.exports = () => {}');
const { stderr: _err } = await ng('build');
if (!_err.includes("file export function instead of object")) {
throw new Error('Expected tailwind config error');
}


// Remove configuration file
await deleteFile('tailwind.config.js');

// Ensure Tailwind is disabled when no configuration file is present
await ng('build');
await expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components;');
await expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components;');
await expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components; @tailwind utilities');
await expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components; @tailwind utilities');

// Recreate configuration file
await silentExec('npx', 'tailwindcss', 'init');
Expand All @@ -55,6 +109,6 @@ export default async function () {
}

// Tailwind directives should be unprocessed with missing package
await expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components;');
await expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components;');
await expectFileToMatch('dist/test-project/styles.css', '@tailwind base; @tailwind components; @tailwind utilities');
await expectFileToMatch('dist/test-project/main.js', '@tailwind base; @tailwind components; @tailwind utilities');
}