diff options
Diffstat (limited to 'node_modules/uglifyjs-webpack-plugin/README.md')
| -rw-r--r-- | node_modules/uglifyjs-webpack-plugin/README.md | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/node_modules/uglifyjs-webpack-plugin/README.md b/node_modules/uglifyjs-webpack-plugin/README.md new file mode 100644 index 000000000..f5713fd1b --- /dev/null +++ b/node_modules/uglifyjs-webpack-plugin/README.md @@ -0,0 +1,172 @@ +[![npm][npm]][npm-url] +[![deps][deps]][deps-url] +[![test][test]][test-url] +[![coverage][cover]][cover-url] +[![quality][quality]][quality-url] +[![chat][chat]][chat-url] + +<div align="center"> + <!-- replace with accurate logo e.g from https://worldvectorlogo.com/ --> + <a href="https://github.com/webpack/webpack"> + <img width="200" height="200" vspace="" hspace="25" + src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg"> + </a> + <h1>UglifyJS Webpack Plugin</h1> + <p>This plugin uses <a href="https://github.com/mishoo/UglifyJS2/tree/v2.x">UglifyJS v2</a> to minify your JavaScript.<p> +</div> + +> Note that webpack contains the same plugin under `webpack.optimize.UglifyJsPlugin`. This is a standalone version for those that want to control the version of UglifyJS. The documentation is valid apart from the installation instructions in that case. + +<h2 align="center">Install</h2> + +With [Yarn](https://yarnpkg.com): + +```bash +yarn add uglifyjs-webpack-plugin --dev +``` + +With npm: + +```bash +npm install uglifyjs-webpack-plugin --save-dev +``` + +**Important!** The plugin has a peer dependency to uglify-js, so in order to use the plugin, also uglify-js has to be installed. The currently (2017/1/25) available uglify-js npm packages; however, do not support minification of ES6 code. In order to support ES6, an ES6-capable, a.k.a. _harmony_, version of UglifyJS has to be provided. + +If your minification target is ES6: + +```bash +yarn add git://github.com/mishoo/UglifyJS2#harmony-v2.8.22 --dev +``` + +If your minification target is ES5: + +```bash +yarn add uglify-js --dev +``` + +<h2 align="center">Usage</h2> + +```javascript +const UglifyJSPlugin = require('uglifyjs-webpack-plugin'); + +module.exports = { + entry: {...}, + output: {...}, + module: {...}, + plugins: [ + new UglifyJSPlugin() + ] +}; +``` + +<h2 align="center">Options</h2> + +This plugin supports UglifyJS features as discussed below: + +| Property | Type | Default | Description | +| --- | --- | --- | --- | +| compress | boolean, object | true | See [UglifyJS documentation](http://lisperator.net/uglifyjs/compress). | +| mangle | boolean, object | true | See below. | +| beautify | boolean | false | Beautify output. | +| output | An object providing options for UglifyJS [OutputStream](https://github.com/mishoo/UglifyJS2/blob/v2.x/lib/output.js) | | Lower level access to UglifyJS output. | +| comments | boolean, RegExp, function(astNode, comment) -> boolean | Defaults to preserving comments containing `/*!`, `/**!`, `@preserve` or `@license`. | Comment related configuration. | +| extractComments | boolean, RegExp, function (astNode, comment) -> boolean, object | false | Whether comments shall be extracted to a separate file, see below. | +| sourceMap | boolean | false | Use SourceMaps to map error message locations to modules. This slows down the compilation. **Important!** `cheap` source map options don't work with the plugin! | +| test | RegExp, Array<RegExp> | <code>/\.js($|\?)/i</code> | Test to match files against. | +| include | RegExp, Array<RegExp> | | Test only `include` files. | +| exclude | RegExp, Array<RegExp> | | Files to `exclude` from testing. | +| extractComments | boolean, RegExp, object | | Extract comments to separate file (see [details](https://github.com/webpack/webpack/commit/71933e979e51c533b432658d5e37917f9e71595a), since webpack 2.3.0) | +| warningsFilter | function(source) -> boolean | | Allow to filter uglify warnings (since webpack 2.3.0) | + +<h2 align="center">Mangling</h2> + +`mangle (boolean|object)` - Passing `true` or an object enables and provides options for UglifyJS name mangling. See [UglifyJS documentation](https://github.com/mishoo/UglifyJS2/tree/v2.x#mangle) for mangle options. Example configuration, this will **not** mangle properties (see below): + +```javascript +new UglifyJsPlugin({ + mangle: { + // Skip mangling these + except: ['$super', '$', 'exports', 'require'] + } +}) +``` + +`mangle.props (boolean|object)` - Passing `true` or an object enables and provides options for UglifyJS property mangling - see [UglifyJS documentation](https://github.com/mishoo/UglifyJS2/tree/v2.x#mangleproperties-options) for mangleProperties options. + +> Note: the UglifyJS docs warn that [you will probably break your source if you use property mangling](https://github.com/mishoo/UglifyJS2/tree/v2.x#mangling-property-names---mangle-props), so if you aren’t sure why you’d need this feature, you most likely shouldn’t be using it! This is **not** enabled by default. + +Example configuration, this will mangle both names and properties: + +```javascript +new UglifyJsPlugin({ + mangle: { + props: true + } +}) +``` + +<h2 align="center">Extracting Comments</h2> + +The `extractComments` option can be +- `true`: 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` +- regular expression (given as `RegExp` or `string`) or a `function (astNode, 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. +- an `object` consisting of the following keys, all optional: + - `condition`: regular expression or function (see previous point) + - `filename`: The file where the extracted comments will be stored. Can be either a `string` or `function (string) -> string` which will be given the original filename. Default is to append the suffix `.LICENSE` to the original filename. + - `banner`: The banner text that points to the extracted file and will be added on top of the original file. will be added to 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. +Default: `/*! For license information please see foo.js.LICENSE */` + + +<h2 align="center">Maintainers</h2> + +<table> + <tbody> + <tr> + <td align="center"> + <img width="150" height="150" + src="https://avatars3.githubusercontent.com/u/166921?v=3&s=150"> + </br> + <a href="https://github.com/bebraw">Juho Vepsäläinen</a> + </td> + <td align="center"> + <img width="150" height="150" + src="https://avatars2.githubusercontent.com/u/8420490?v=3&s=150"> + </br> + <a href="https://github.com/d3viant0ne">Joshua Wiens</a> + </td> + <td align="center"> + <img width="150" height="150" + src="https://avatars3.githubusercontent.com/u/533616?v=3&s=150"> + </br> + <a href="https://github.com/SpaceK33z">Kees Kluskens</a> + </td> + <td align="center"> + <img width="150" height="150" + src="https://avatars3.githubusercontent.com/u/3408176?v=3&s=150"> + </br> + <a href="https://github.com/TheLarkInn">Sean Larkin</a> + </td> + </tr> + <tbody> +</table> + + +[npm]: https://img.shields.io/npm/v/uglifyjs-webpack-plugin.svg +[npm-url]: https://npmjs.com/package/uglifyjs-webpack-plugin + +[deps]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin.svg +[deps-url]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin + +[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg +[chat-url]: https://gitter.im/webpack/webpack + +[test]: https://secure.travis-ci.org/webpack-contrib/uglifyjs-webpack-plugin.svg +[test-url]: http://travis-ci.org/webpack-contrib/uglifyjs-webpack-plugin + +[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 + +[quality]: https://www.bithound.io/github/webpack-contrib/uglifyjs-webpack-plugin/badges/score.svg +[quality-url]: https://www.bithound.io/github/webpack-contrib/uglifyjs-webpack-plugin |