README.md

brotli for Laravel Mix

A wrapper around brotli-webpack-plugin for Laravel Mix.

let mix = require('laravel-mix');
require('laravel-mix-brotli');

// ...

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

Installation

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

You can install the package with yarn or npm:

yarn add laravel-mix-brotli

npm install laravel-mix-brotli

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

let mix = require('laravel-mix');
require('laravel-mix-brotli');

// ...

brotli can then be enabled by calling .brotli() in your Mix chain.

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

Custom options can be passed when calling brotli if necessary.

mix.js('resources/js/app.js', 'public/js')
   .sass('resources/sass/app.scss', 'public/css')
   .brotli({
                    enabled: mix.inProduction(),
           			asset: '[path].br[query]',
           			test: /\.(js|css|html|svg)$/,
           			threshold: 10240,
           			minRatio: 0.8
           		});

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

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