PurgeCSS wrapper for Laravel Mix

🚨🚨🚨

WARNING! This is the master branch of laravel-mix-purgecss. The latest stable release is version 4.1.0.

🚨🚨🚨

This package adds a purgeCss option to Laravel Mix, which installs PurgeCSS for you with a set of sensible defaults for Laravel applications.

const mix = require('laravel-mix');
require('laravel-mix-purgecss');

// ...

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .purgeCss();

Before you get started, make sure you're using laravel-mix version 5.0.0 or higher.

You can install the package with yarn or npm:

yarn add laravel-mix-purgecss --dev

npm install laravel-mix-purgecss --save-dev

Then install the extension by requiring the module in your Mix configuration.

const mix = require('laravel-mix');
require('laravel-mix-purgecss');

// ...

PurgeCSS can be enabled by calling .purgeCss() in your Mix chain.

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .purgeCss();

By default, PurgeCSS only works when building assets for production. You can override this behaviour by specifying the enabled option.

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .purgeCss({
       enabled: true,
   });

Our defaultConfig file contains a set of sensible defaults for Laravel applications.

Custom options can be passed when calling PurgeCSS if necessary. Visit PurgeCSS' docs to learn more about the available options.

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .purgeCss({
       content: [path.join(__dirname, 'vendor/spatie/menu/**/*.php')],
       whitelistPatterns: [/hljs/],
   });

Passing options will override the package defaults. If you want to extend the package defaults, wrap them in an extend object.

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .purgeCss({
       extend: {
           content: [path.join(__dirname, 'vendor/spatie/menu/**/*.php')],
           whitelistPatterns: [/hljs/],
       },
   });

Please see CHANGELOG for more information what has changed recently.

Please see CONTRIBUTING for details.

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.

• Sebastian De Deyne
• CJMAXiK
• Aryeh Raber
• All Contributors

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

The MIT License (MIT). Please see License File for more information.