uglifyjs-webpack-plugin
v1.0.0-rc.0
UglifyJS plugin for webpack
0/weekUpdated 2 years agoMIT
Published by webpack Contrib Team
npm install uglifyjs-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]
UglifyJS Webpack Plugin
This plugin uses uglify-js to minify your JavaScript.
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 uglifyjs-webpack-plugin:
``console`
$ npm install uglifyjs-webpack-plugin --save-dev
Then add the plugin to your webpack config. For example:
webpack.config.js
`js
const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
module.exports = {
optimization: {
minimizer: [new UglifyJsPlugin()],
},
};
`
And run webpack via your preferred method.
Options
$3
Type: String|RegExp|Array
Default:
Test to match files against.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
test: /\.js(\?.*)?$/i,
}),
],
},
};
$3
Type: String|RegExp|Array
Default:
Files to include.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
include: /\/includes/,
}),
],
},
};
$3
Type: String|RegExp|Array
Default:
Files to exclude.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
exclude: /\/excludes/,
}),
],
},
};
$3
Type: Function<(chunk) -> boolean>
Default:
Allowing to filter which chunks should be uglified (by default all chunks are uglified).
Return true to uglify the chunk, false otherwise.
webpack.config.js
`jsvendor
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
chunkFilter: (chunk) => {
// Exclude uglification for the chunk
if (chunk.name === 'vendor') {
return false;
}
return true;
},
}),
],
},
};
`
$3
Type: Boolean|String
Default:
Enable file caching.
Default path to cache directory: node_modules/.cache/uglifyjs-webpack-plugin.
> ℹ️ If you use your own minify function please read the minify section for cache invalidation correctly.
#### Boolean
Enable/disable file caching.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: true,
}),
],
},
};
#### String
Enable file caching and set path to cache directory.
webpack.config.js
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: 'path/to/cache',
}),
],
},
};
$3
Type: Function<(defaultCacheKeys, file) -> Object>
Default:
Allows you to override default cache keys.
Default cache keys:
`js${compiler.outputPath}/${file}
({
'uglify-js': require('uglify-js/package.json').version, // uglify version
'uglifyjs-webpack-plugin': require('../package.json').version, // plugin version
'uglifyjs-webpack-plugin-options': this.options, // plugin options
path: compiler.outputPath ? : file, // asset path`
hash: crypto
.createHash('md4')
.update(input)
.digest('hex'), // source file hash
});
webpack.config.js
`js
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: true,
cacheKeys: (defaultCacheKeys, file) => {
defaultCacheKeys.myCacheKey = 'myCacheKeyValue';
return defaultCacheKeys;
},
}),
],
},
};
`
$3
Type: Boolean|Number
Default:
Use multi-process parallel running to improve the build speed.
Default number of concurrent runs: os.cpus().length - 1.
> ℹ️ Parallelization can speedup your build significantly and is therefore highly recommended.
#### Boolean
Enable/disable multi-process parallel running.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
parallel: true,
}),
],
},
};
#### Number
Enable multi-process parallel running and set number of concurrent runs.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
parallel: 4,
}),
],
},
};
$3
Type: Boolean
Default:
Use source maps to map error message locations to modules (this slows down the compilation).
If you use your own minify function please read the minify section for handling source maps correctly.
> ⚠️ cheap-source-map options don't work with this plugin.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
sourceMap: true,
}),
],
},
};
$3
Type: Function
Default:
Allows you to override default minify function.
By default plugin uses uglify-js package.
Useful for using and testing unpublished versions or forks.
> ⚠️ Always use require inside minify function when parallel option enabled.
webpack.config.js
`js
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
minify(file, sourceMap) {
const extractedComments = [];
// Custom logic for extract comments
const { error, map, code, warnings } = require('uglify-module') // Or require('./path/to/uglify-module')
.minify(file, {
/ Your options for minification /
});
return { error, map, code, warnings, extractedComments };
},
}),
],
},
};
`
$3
Type: Object
Default: default
UglifyJS minify options.
webpack.config.js
`jsmangle.properties
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
uglifyOptions: {
warnings: false,
parse: {},
compress: {},
mangle: true, // Note is false by default.`
output: null,
toplevel: false,
nameCache: null,
ie8: false,
keep_fnames: false,
},
}),
],
},
};
$3
Type: Boolean|String|RegExp|Function<(node, comment) -> Boolean|Object>
Default:
Whether comments shall be extracted to a separate file, (see details).
By default extract only comments using /^\**!|@preserve|@license|@cc_on/i regexp condition and remove remaining comments.foo.js
If the original file is named , then the comments will be stored to foo.js.LICENSE.uglifyOptions.output.comments
The option specifies whether the comment will be preserved, i.e. it is possible to preserve some comments (e.g. annotations) while extracting others or even preserving comments that have been extracted.
#### Boolean
Enable/disable extracting comments.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: true,
}),
],
},
};
#### String
Extract all or some (use /^\**!|@preserve|@license|@cc_on/i RegExp) comments.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: 'all',
}),
],
},
};
#### RegExp
All comments that match the given expression will be extracted to the separate file.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: /@extract/i,
}),
],
},
};
#### Function<(node, comment) -> Boolean>
All comments that match the given expression will be extracted to the separate file.
webpack.config.js
`js
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: function(astNode, comment) {
if (/@extract/i.test(comment.value)) {
return true;
}
return false;
},
}),
],
},
};
`
#### Object
Allow to customize condition for extract comments, specify extracted file name and banner.
webpack.config.js
`js${file}.LICENSE
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: {
condition: /^\**!|@preserve|@license|@cc_on/i,
filename(file) {
return ;License information can be found in ${licenseFile}
},
banner(licenseFile) {
return ;`
},
},
}),
],
},
};
##### condition
Type: Boolean|String|RegExp|Function<(node, comment) -> Boolean|Object>
Condition what comments you need extract.
webpack.config.js
`js${file}.LICENSE
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: {
condition: 'some',
filename(file) {
return ;License information can be found in ${licenseFile}
},
banner(licenseFile) {
return ;`
},
},
}),
],
},
};
##### filename
Type: Regex|Function<(string) -> String>
Default:
The file where the extracted comments will be stored.
Default is to append the suffix .LICENSE to the original filename.
webpack.config.js
`jsLicense information can be found in ${licenseFile}
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: {
condition: /^\**!|@preserve|@license|@cc_on/i,
filename: 'extracted-comments.js',
banner(licenseFile) {
return ;`
},
},
}),
],
},
};
##### banner
Type: Boolean|String|Function<(string) -> String>
Default:
The banner text that points to the extracted file and will be added on top of the original file.
Can be false (no banner), a String, or a Function<(string) -> String> that will be called with the filename where extracted comments have been stored.
Will be wrapped into comment.
webpack.config.js
`js${file}.LICENSE
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
extractComments: {
condition: true,
filename(file) {
return ;My custom banner about license information ${commentsFile}
},
banner(commentsFile) {
return ;`
},
},
}),
],
},
};
$3
Type: Function<(warning, source) -> Boolean>
Default:
Allow to filter uglify-js warnings.
Return true to keep the warning, false otherwise.
webpack.config.js
`js
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
warningsFilter: (warning, source) => {
if (/Dropping unreachable code/i.test(warning)) {
return true;
}
if (/filename\.js/i.test(source)) {
return true;
}
return false;
},
}),
],
},
};
`
Examples
$3
Enable cache and multi-process parallel running.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
cache: true,
parallel: true,
}),
],
},
};
$3
Extract all legal comments (i.e. /^\**!|@preserve|@license|@cc_on/i) and preserve /@license/i comments.
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
uglifyOptions: {
output: {
comments: /@license/i,
},
},
extractComments: true,
}),
],
},
};
$3
If you avoid building with comments, set uglifyOptions.output.comments to false as in this config:
webpack.config.js
`js`
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
uglifyOptions: {
output: {
comments: false,
},
},
}),
],
},
};
$3
Override default minify function - use terser for minification.
webpack.config.js
`jsuglify-js
module.exports = {
optimization: {
minimizer: [
new UglifyJsPlugin({
// Uncomment lines below for cache invalidation correctly
// cache: true,
// cacheKeys(defaultCacheKeys) {
// delete defaultCacheKeys['uglify-js'];
//
// return Object.assign(
// {},
// defaultCacheKeys,
// { 'uglify-js': require('uglify-js/package.json').version },
// );
// },
minify(file, sourceMap) {
// https://github.com/mishoo/UglifyJS2#minify-options
const uglifyJsOptions = {
/ your package options /
};
if (sourceMap) {
uglifyJsOptions.sourceMap = {
content: sourceMap,
};
}
return require('terser').minify(file, uglifyJsOptions);
},
}),
],
},
};
``
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/uglifyjs-webpack-plugin.svg
[npm-url]: https://npmjs.com/package/uglifyjs-webpack-plugin
[node]: https://img.shields.io/node/v/uglifyjs-webpack-plugin.svg
[node-url]: https://nodejs.org
[deps]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin.svg
[deps-url]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin
[tests]: https://dev.azure.com/webpack-contrib/uglifyjs-webpack-plugin/_apis/build/status/webpack-contrib.uglifyjs-webpack-plugin?branchName=master
[tests-url]: https://dev.azure.com/webpack-contrib/uglifyjs-webpack-plugin/_build/latest?definitionId=8&branchName=master
[cover]: https://codecov.io/gh/webpack-contrib/uglifyjs-webpack-plugin/branch/master/graph/badge.svg
[cover-url]: https://codecov.io/gh/webpack-contrib/uglifyjs-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=uglifyjs-webpack-plugin
[size-url]: https://packagephobia.now.sh/result?p=uglifyjs-webpack-plugin