uglifyjs-webpack-plugin3

UglifyJS plugin for webpack

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
uglifyjs-webpack-plugin3
1,38341.0.0-beta7 years ago7 years agoMinified + gzip package size for uglifyjs-webpack-plugin3 in KB

Readme

!npmnpmnpm-url !nodenodenode-url !depsdepsdeps-url !testtesttest-url !coveragecovercover-url !chatchatchat-url
<img width="200" height="200"
  src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
UglifyJS Webpack Plugin
<p>This plugin uses <a href="https://github.com/mishoo/UglifyJS2/tree/harmony">UglifyJS v3</a> to minify your JavaScript<p>

ℹ️ webpack contains the same plugin under webpack.optimize.UglifyJsPlugin. The documentation is valid apart from the installation instructions

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| |:--:|:--:|:-----:|:----------| |test|{RegExp\|Array<RegExp>}| /\.js($|\?)/i|Test to match files against| |include|{RegExp\|Array<RegExp>}|undefined|Files to include| |exclude|{RegExp\|Array<RegExp>}|undefined|Files to exclude| |parallel|{Boolean\|Object}|false|Use multi-process parallel running and file cache to improve the build speed| |sourceMap|{Boolean}|false|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| |uglifyOptions|{Object}|{...defaults}|uglify Options| |extractComments|{Boolean\|RegExp\|Function<(node, comment) -> {Boolean\|Object}>}|false|Whether comments shall be extracted to a separate file, (see details (webpack >= 2.3.0)| |warningsFilter|{Function(source) -> {Boolean}}|``|Allow to filter uglify warnings|

test

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

include

webpack.config.js
[
  new UglifyJSPlugin({
    include: /\/includes/
  })
]

exclude

webpack.config.js
[
  new UglifyJSPlugin({
    exclude: /\/excludes/
  })
]

parallel

webpack.config.js
[
  new UglifyJSPlugin({
    parallel: true
  })
]

|Name|Type|Default|Description| |:--:|:--:|:-----:|:----------| |cache|{Boolean}|node_modules/.cache/uglifyjs-webpack-plugin|Enable file caching| |workers|{Boolean\|Object}|os.cpus().length - 1|Number of concurrent runs, default is the maximum|
webpack.config.js
[
  new UglifyJSPlugin({
    parallel: {
      cache: true
      workers: 2 // for e.g
    }
  })
]

ℹ️ 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| |:--:|:--:|:-----:|:----------| |ie8|{Boolean}|false|Enable IE8 Support| |ecma|{Number}|undefined|Supported ECMAScript Version (5, 6, 7 or 8). Affects parse, compress && output options| |parse|{Object}|{}|Additional Parse Options| |mangle|{Boolean\|Object}|true|Enable Name Mangling (See Mangle Properties for advanced setups, use with ⚠️)| |output|{Object}|{}|Additional Output Options (The defaults are optimized for best compression)| |compress|{Boolean\|Object}|true|Additional Compress Options| |warnings|{Boolean}|false|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| |:--:|:--:|:-----:|:----------| |
condition|{Regex\|Function}|``|Regular Expression or function (see previous point)| |filename|{String\|Function}|compilation.assets[file]|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| |banner|{Boolean\|String\|Function}|/*! For license information please see ${filename}.js.LICENSE */|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


<tr>
  <td align="center">
    <a href="https://github.com/hulkish">
      <img width="150" height="150" src="https://github.com/hulkish.png?size=150">
      </br>
      Steven Hargrove
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/bebraw">
      <img width="150" height="150" src="https://github.com/bebraw.png?v=3&s=150">
      </br>
      Juho Vepsäläinen
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/d3viant0ne">
      <img width="150" height="150" src="https://github.com/d3viant0ne.png?v=3&s=150">
      </br>
      Joshua Wiens
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/michael-ciniawsky">
      <img width="150" height="150" src="https://github.com/michael-ciniawsky.png?v=3&s=150">
      </br>
      Michael Ciniawsky
    </a>
  </td>
  <td align="center">
    <a href="https://github.com/evilebottnawi">
      <img width="150" height="150" src="https://github.com/evilebottnawi.png?v=3&s=150">
      </br>
      Alexander Krasnoyarov
    </a>
  </td>
</tr>