1.0.0-beta.5 • Published 7 years ago

@easymetrics/uglifyjs-webpack-plugin-flat v1.0.0-beta.5

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

npm node deps test coverage chat

⚠️ This documentation is for the current beta. For latest stable, see v0.4.6.

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

npm i -D uglifyjs-webpack-plugin@beta

webpack.config.js

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

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

⚠️ The following options are for the latest beta version. If you would like to see the options for the latest built-in version of the plugin in webpack, see the v0.4.6 docs.

NameTypeDefaultDescription
test{RegExp\|Array<RegExp>}/\.js$/iTest to match files against
include{RegExp\|Array<RegExp>}undefinedFiles to include
exclude{RegExp\|Array<RegExp>}undefinedFiles to exclude
cache{Boolean\|String}falseEnable file caching
parallel{Boolean\|Number}falseUse multi-process parallel running and file cache to improve the build speed
sourceMap{Boolean}falseUse 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}>}falseWhether comments shall be extracted to a separate file, (see details (webpack >= 2.3.0)
warningsFilter{Function(source) -> {Boolean}}() => trueAllow to filter uglify warnings

test

webpack.config.js

[
  new UglifyJSPlugin({
    test: /\.js($&#124;\?)/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

NameTypeDefaultDescription
ie8{Boolean}falseEnable IE8 Support
ecma{Number}undefinedSupported ECMAScript Version (5, 6, 7 or 8). Affects parse, compress && output options
parse{Object}{}Additional Parse Options
mangle{Boolean\|Object}trueEnable 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}trueAdditional Compress Options
warnings{Boolean}falseDisplay 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}

NameTypeDefaultDescription
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
  })
]