@theia/compression-webpack-plugin
v3.0.0
Prepare compressed versions of assets to serve them with Content-Encoding
0/weekUpdated 4 months agoMITUnpacked: 30.0 KB
Published by Tobias Koppers @sokra
npm install @theia/compression-webpack-plugin
[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![cover][cover]][cover-url]
[![chat][chat]][chat-url]
[![size][size]][size-url]
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:
``console`
$ npm install compression-webpack-plugin --save-dev
Then add the plugin to your webpack config. For example:
webpack.config.js
`js
const CompressionPlugin = require('compression-webpack-plugin');
module.exports = {
plugins: [new CompressionPlugin()],
};
`
And run webpack via your preferred method.
Options
$3
Type: String|RegExp|Array
Default:
Test to match files against.
`js`
// in your webpack.config.js
new CompressionPlugin({
test: /\.js(\?.*)?$/i,
});
$3
Type: String|RegExp|Array
Default:
Files to include.
`js`
// in your webpack.config.js
new CompressionPlugin({
include: /\/includes/,
});
$3
Type: String|RegExp|Array
Default:
Files to exclude.
`js`
// in your webpack.config.js
new CompressionPlugin({
exclude: /\/excludes/,
});
$3
Type: Boolean|String
Default:
Enable file caching.
The default path to cache directory: node_modules/.cache/compression-webpack-plugin.
#### Boolean
Enable/disable file caching.
`js`
// in your webpack.config.js
new CompressionPlugin({
cache: true,
});
#### String
Enable file caching and set path to cache directory.
`js`
// in your webpack.config.js
new CompressionPlugin({
cache: 'path/to/cache',
});
$3
Type: String|Function
Default:
The target asset filename.
#### String
[file] is replaced with the original asset filename.[path] is replaced with the path of the original asset.[query] is replaced with the query.
`js`
// in your webpack.config.js
new CompressionPlugin({
filename: '[path].gz[query]',
});
#### Function
`js${info.path}.gz${info.query}
// in your webpack.config.js
new CompressionPlugin({
filename(info) {
// info.file is the original asset filename
// info.path is the path of the original asset
// info.query is the query
return ;`
},
});
$3
Type: String|Function
Default:
The compression algorithm/function.
#### String
The algorithm is taken from zlib.
`js`
// in your webpack.config.js
new CompressionPlugin({
algorithm: 'gzip',
});
#### Function
Allow to specify a custom compression function.
`js`
// in your webpack.config.js
new CompressionPlugin({
algorithm(input, compressionOptions, callback) {
return compressionFunction(input, compressionOptions, callback);
},
});
$3
Type: Object
Default:
If you use custom function for the algorithm option, the default value is {}.
Compression options.
You can find all options here zlib.
`js`
// in your webpack.config.js
new CompressionPlugin({
compressionOptions: { level: 1 },
});
$3
Type: Number
Default:
Only assets bigger than this size are processed. In bytes.
`js`
// in your webpack.config.js
new CompressionPlugin({
threshold: 8192,
});
$3
Type: Number
Default:
Only assets that compress better than this ratio are processed (minRatio = Compressed Size / Original Size).image.png
Example: you have file with 1024b size, compressed version of file has 768b size, so minRatio equal 0.75.Compressed Size / Original Size
In other words assets will be processed when the value less minRatio value.1
You can use value to process all assets.
`js`
// in your webpack.config.js
new CompressionPlugin({
minRatio: 0.8,
});
$3
Type: Boolean
Default:
Whether to delete the original assets or not.
`js`
// in your webpack.config.js
new CompressionPlugin({
deleteOriginalAssets: true,
});
Examples
$3
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:
`console`
$ npm install @gfx/zopfli --save-dev
webpack.config.js
`js
const zopfli = require('@gfx/zopfli');
module.exports = {
plugins: [
new CompressionPlugin({
compressionOptions: {
numiterations: 15,
},
algorithm(input, compressionOptions, callback) {
return zopfli.gzip(input, compressionOptions, callback);
},
}),
],
};
`
$3
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:
`js`
// in your webpack.config.js
module.exports = {
plugins: [
new CompressionPlugin({
filename: '[path].br[query]',
algorithm: 'brotliCompress',
test: /\.(js|css|html|svg)$/,
compressionOptions: { level: 11 },
threshold: 10240,
minRatio: 0.8,
deleteOriginalAssets: false,
}),
],
};
N.B.: The level option matches BROTLI_PARAM_QUALITY` for Brotli-based streams
Contributing
Please take a moment to read our contributing guidelines if you haven't yet done so.
License
[npm]: https://img.shields.io/npm/v/compression-webpack-plugin.svg
[npm-url]: https://npmjs.com/package/compression-webpack-plugin
[node]: https://img.shields.io/node/v/compression-webpack-plugin.svg
[node-url]: https://nodejs.org
[deps]: https://david-dm.org/webpack-contrib/compression-webpack-plugin.svg
[deps-url]: https://david-dm.org/webpack-contrib/compression-webpack-plugin
[tests]: https://dev.azure.com/webpack-contrib/compression-webpack-plugin/_apis/build/status/webpack-contrib.compression-webpack-plugin?branchName=master
[tests-url]: https://dev.azure.com/webpack-contrib/compression-webpack-plugin/_build/latest?definitionId=2&branchName=master
[cover]: https://codecov.io/gh/webpack-contrib/compression-webpack-plugin/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/webpack-contrib/compression-webpack-plugin
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
[chat-url]: https://gitter.im/webpack/webpack
[size]: https://packagephobia.now.sh/badge?p=compression-webpack-plugin
[size-url]: https://packagephobia.now.sh/result?p=compression-webpack-plugin