UglifyjsWebpackPlugin

This plugin uses UglifyJS v3 (uglify-es) to minify your JavaScript

ℹ️ webpack =< v3.0.0 currently contains v0.4.6 of this plugin under webpack.optimize.UglifyJsPlugin as an alias. For usage of the latest version (v1.0.0), please follow the instructions below. Aliasing v1.0.0 as webpack.optimize.UglifyJsPlugin is scheduled for webpack v4.0.0

Install

npm i -D uglifyjs-webpack-plugin

Usage

webpack.config.js

const UglifyJsPlugin = require('uglifyjs-webpack-plugin')

module.exports = {
  plugins: [
    new UglifyJsPlugin()
  ]
}

Options

Name
Type
Default
Description
Name
test
Type
{RegExp|Array<RegExp>}
Default
/\.js$/i
Description
Test to match files against
Name
include
Type
{RegExp|Array<RegExp>}
Default
undefined
Description
Files to include
Name
exclude
Type
{RegExp|Array<RegExp>}
Default
undefined
Description
Files to exclude
Name
cache
Type
{Boolean|String}
Default
false
Description
Enable file caching
Name
parallel
Type
{Boolean|Number}
Default
false
Description
Use multi-process parallel running to improve the build speed
Name
sourceMap
Type
{Boolean}
Default
false
Description
Use source maps to map error message locations to modules (This slows down the compilation) ⚠️ cheap-source-map options don't work with this plugin
Name
uglifyOptions
Type
{Object}
Default
{...defaults}
Description
uglify Options
Name
extractComments
Type
{Boolean|RegExp|Function<(node, comment) -> {Boolean|Object}>}
Default
false
Description
Whether comments shall be extracted to a separate file, (see details (webpack >= 2.3.0)
Name
warningsFilter
Type
{Function(source) -> {Boolean}}
Default
() => true
Description
Allow to filter uglify warnings

##

webpack.config.js

[
  new UglifyJsPlugin({
    test: /\.js($|\?)/i
  })
]

include

webpack.config.js

[
  new UglifyJsPlugin({
    include: /\/includes/
  })
]

exclude

webpack.config.js

[
  new UglifyJsPlugin({
    exclude: /\/excludes/
  })
]

cache

{Boolean}

webpack.config.js

[
  new UglifyJsPlugin({
    cache: true
  })
]

Enable file caching. Default path to cache directory: node_modules/.cache/uglifyjs-webpack-plugin.

{String}

webpack.config.js

[
  new UglifyJsPlugin({
    cache: 'path/to/cache'
  })
]

Path to cache directory.

parallel

{Boolean}

webpack.config.js

[
  new UglifyJsPlugin({
    parallel: true
  })
]

Enable parallelization. Default number of concurrent runs: os.cpus().length - 1.

{Number}

webpack.config.js

[
  new UglifyJsPlugin({
    parallel: 4
  })
]

Number of concurrent runs.

ℹ️ Parallelization can speedup your build significantly and is therefore highly recommended

sourceMap

webpack.config.js

[
  new UglifyJsPlugin({
    sourceMap: true
  })
]

⚠️ cheap-source-map options don't work with this plugin

uglifyOptions

Name
Type
Default
Description
Name
ie8
Type
{Boolean}
Default
false
Description
Enable IE8 Support
Name
ecma
Type
{Number}
Default
undefined
Description
Supported ECMAScript Version (5, 6, 7 or 8). Affects parse, compress && output options
Name
parse
Type
{Object}
Default
{}
Description
Additional Parse Options
Name
mangle
Type
{Boolean|Object}
Default
true
Description
Enable Name Mangling (See Mangle Properties for advanced setups, use with ⚠️)
Name
output
Type
{Object}
Default
{}
Description
Additional Output Options (The defaults are optimized for best compression)
Name
compress
Type
{Boolean|Object}
Default
true
Description
Additional Compress Options
Name
warnings
Type
{Boolean}
Default
false
Description
Display Warnings

webpack.config.js

[
  new UglifyJsPlugin({
    uglifyOptions: {
      ie8: false,
      ecma: 8,
      parse: {...options},
      mangle: {
        ...options,
        properties: {
          // mangle property options
        }
      },
      output: {
        comments: false,
        beautify: false,
        ...options
      },
      compress: {...options},
      warnings: false
    }
  })
]

extractComments

{Boolean}

All comments that normally would be preserved by the comments option will be moved to a separate file. If the original file is named foo.js, then the comments will be stored to foo.js.LICENSE.

{RegExp|String} or {Function<(node, comment) -> {Boolean}>}

All comments that match the given expression (resp. are evaluated to true by the function) will be extracted to the separate file. The comments 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.

{Object}

Name
Type
Default
Description
Name
condition
Type
{Regex|Function}
Default
``
Description
Regular Expression or function (see previous point)
Name
filename
Type
{String|Function}
Default
${file}.LICENSE
Description
The file where the extracted comments will be stored. Can be either a {String} or a {Function<(string) -> {String}>}, which will be given the original filename. Default is to append the suffix .LICENSE to the original filename
Name
banner
Type
{Boolean|String|Function}
Default
/*! For license information please see ${filename}.js.LICENSE */
Description
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

warningsFilter

webpack.config.js

[
  new UglifyJsPlugin({
    warningsFilter: (src) => true
  })
]

Maintainers


      Steven Hargrove



      Juho Vepsäläinen



      Joshua Wiens



      Michael Ciniawsky



      Alexander Krasnoyarov