compression-webpack-plugin

Prepare compressed versions of assets to serve them with Content-Encoding.

Requirements

This module requires a minimum of Node v6.9.0 and Webpack v4.0.0.

Getting Started

To begin, you'll need to install compression-webpack-plugin:

1$ npm install compression-webpack-plugin --save-dev

Then add the plugin to your webpack config. For example:

webpack.config.js

1const CompressionPlugin = require('compression-webpack-plugin');
2
3module.exports = {
4  plugins: [new CompressionPlugin()],
5};

And run webpack via your preferred method.

Options

test

Type: String|RegExp|Array<String|RegExp> Default: undefined

Test to match files against.

1// in your webpack.config.js
2new CompressionPlugin({
3  test: /\.js(\?.*)?$/i,
4});

include

Type: String|RegExp|Array<String|RegExp> Default: undefined

Files to include.

1// in your webpack.config.js
2new CompressionPlugin({
3  include: /\/includes/,
4});

exclude

Type: String|RegExp|Array<String|RegExp> Default: undefined

Files to exclude.

1// in your webpack.config.js
2new CompressionPlugin({
3  exclude: /\/excludes/,
4});

cache

Type: Boolean|String Default: false

Enable file caching. The default path to cache directory: node_modules/.cache/compression-webpack-plugin.

Boolean

Enable/disable file caching.

1// in your webpack.config.js
2new CompressionPlugin({
3  cache: true,
4});

String

Enable file caching and set path to cache directory.

1// in your webpack.config.js
2new CompressionPlugin({
3  cache: 'path/to/cache',
4});

filename

Type: String|Function Default: [path].gz[query]

The target asset filename.

String

[file] is replaced with the original asset filename. [path] is replaced with the path of the original asset. [dir] is replaced with the directory of the original asset. [name] is replaced with the filename of the original asset. [ext] is replaced with the extension of the original asset. [query] is replaced with the query.

1// in your webpack.config.js
2new CompressionPlugin({
3  filename: '[path].gz[query]',
4});
5
6new CompressionPlugin({
7  filename: '[dir][name].gz[ext][query]',
8});

Function

1// in your webpack.config.js
2new CompressionPlugin({
3  filename(info) {
4    // info.file is the original asset filename
5    // info.path is the path of the original asset
6    // info.query is the query
7    return `${info.path}.gz${info.query}`;
8  },
9});

algorithm

Type: String|Function Default: gzip

The compression algorithm/function.

String

The algorithm is taken from zlib.

1// in your webpack.config.js
2new CompressionPlugin({
3  algorithm: 'gzip',
4});

Function

Allow to specify a custom compression function.

1// in your webpack.config.js
2new CompressionPlugin({
3  algorithm(input, compressionOptions, callback) {
4    return compressionFunction(input, compressionOptions, callback);
5  },
6});

compressionOptions

Type: Object Default: { level: 9 }

If you use custom function for the algorithm option, the default value is {}.

Compression options. You can find all options here zlib.

1// in your webpack.config.js
2new CompressionPlugin({
3  compressionOptions: { level: 1 },
4});

threshold

Type: Number Default: 0

Only assets bigger than this size are processed. In bytes.

1// in your webpack.config.js
2new CompressionPlugin({
3  threshold: 8192,
4});

minRatio

Type: Number Default: 0.8

Only assets that compress better than this ratio are processed (minRatio = Compressed Size / Original Size). Example: you have image.png file with 1024b size, compressed version of file has 768b size, so minRatio equal 0.75. In other words assets will be processed when the Compressed Size / Original Size value less minRatio value. You can use 1 value to process assets that are smaller than the original. Use a value of Number.MAX_SAFE_INTEGER to process all assets even if they are larger than the original (useful when you are pre-zipping all assets for AWS)

1// in your webpack.config.js
2new CompressionPlugin({
3  minRatio: 0.8,
4});

deleteOriginalAssets

Type: Boolean Default: false

Whether to delete the original assets or not.

1// in your webpack.config.js
2new CompressionPlugin({
3  deleteOriginalAssets: true,
4});

Examples

Using Zopfli

Prepare compressed versions of assets using zopfli library.

ℹ️ @gfx/zopfli require minimum 8 version of node.

To begin, you'll need to install @gfx/zopfli:

1$ npm install @gfx/zopfli --save-dev

webpack.config.js

1const zopfli = require('@gfx/zopfli');
2
3module.exports = {
4  plugins: [
5    new CompressionPlugin({
6      compressionOptions: {
7        numiterations: 15,
8      },
9      algorithm(input, compressionOptions, callback) {
10        return zopfli.gzip(input, compressionOptions, callback);
11      },
12    }),
13  ],
14};

Using Brotli

Brotli is a compression algorithm originally developed by Google, and offers compression superior to gzip.

Node 11.7.0 and later has native support for Brotli compression in its zlib module.

We can take advantage of this built-in support for Brotli in Node 11.7.0 and later by just passing in the appropriate algorithm to the CompressionPlugin:

webpack.config.js

1module.exports = {
2  plugins: [
3    new CompressionPlugin({
4      filename: '[path].br[query]',
5      algorithm: 'brotliCompress',
6      test: /\.(js|css|html|svg)$/,
7      compressionOptions: { level: 11 },
8      threshold: 10240,
9      minRatio: 0.8,
10      deleteOriginalAssets: false,
11    }),
12  ],
13};

N.B.: The level option matches BROTLI_PARAM_QUALITY for Brotli-based streams

Multiple compressed versions of assets for different algorithm

webpack.config.js

1module.exports = {
2  plugins: [
3    new CompressionPlugin({
4      filename: '[path].gz[query]',
5      algorithm: 'gzip',
6      test: /\.js$|\.css$|\.html$/,
7      threshold: 10240,
8      minRatio: 0.8,
9    }),
10    new CompressionPlugin({
11      filename: '[path].br[query]',
12      algorithm: 'brotliCompress',
13      test: /\.(js|css|html|svg)$/,
14      compressionOptions: { level: 11 },
15      threshold: 10240,
16      minRatio: 0.8,
17    }),
18  ],
19};

Contributing

Please take a moment to read our contributing guidelines if you haven't yet done so.

CONTRIBUTING

License

MIT