Skip to content
This repository was archived by the owner on Dec 5, 2019. It is now read-only.

Commit 7654bbc

Browse files
docs(README): standardize
1 parent dabadbc commit 7654bbc

File tree

1 file changed

+174
-79
lines changed

1 file changed

+174
-79
lines changed

README.md

Lines changed: 174 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,137 +1,232 @@
11
[![npm][npm]][npm-url]
2+
[![node][node]][node-url]
23
[![deps][deps]][deps-url]
34
[![test][test]][test-url]
45
[![coverage][cover]][cover-url]
5-
[![quality][quality]][quality-url]
66
[![chat][chat]][chat-url]
77

8+
89
<div align="center">
9-
<!-- replace with accurate logo e.g from https://worldvectorlogo.com/ -->
1010
<a href="https://github.com/webpack/webpack">
11-
<img width="200" height="200" vspace="" hspace="25"
11+
<img width="200" height="200"
1212
src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
1313
</a>
1414
<h1>UglifyJS Webpack Plugin</h1>
15-
<p>This plugin uses <a href="https://github.com/mishoo/UglifyJS2/tree/v2.x">UglifyJS v2</a> to minify your JavaScript.<p>
15+
<p>This plugin uses <a href="https://github.com/mishoo/UglifyJS2/tree/master">UglifyJS v3</a> to minify your JavaScript<p>
1616
</div>
1717

18-
> 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.
18+
> ℹ️ webpack contains the same plugin under `webpack.optimize.UglifyJsPlugin`. The documentation is valid apart from the installation instructions
1919
2020
<h2 align="center">Install</h2>
2121

22-
With [Yarn](https://yarnpkg.com):
23-
24-
```bash
25-
yarn add uglifyjs-webpack-plugin --dev
26-
```
27-
28-
With npm:
29-
3022
```bash
31-
npm install uglifyjs-webpack-plugin --save-dev
23+
npm i -D uglifyjs-webpack-plugin
3224
```
3325

3426
<h2 align="center">Usage</h2>
3527

36-
```javascript
37-
const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
28+
**webpack.config.js**
29+
```js
30+
const UglifyJSPlugin = require('uglifyjs-webpack-plugin')
3831

3932
module.exports = {
40-
entry: {...},
41-
output: {...},
42-
module: {...},
4333
plugins: [
44-
new UglifyJsPlugin()
34+
new UglifyJSPlugin()
4535
]
46-
};
36+
}
4737
```
4838

4939
<h2 align="center">Options</h2>
5040

51-
This plugin supports UglifyJS features as discussed below:
52-
53-
| Property | Type | Default | Description |
54-
| --- | --- | --- | --- |
55-
| compress | boolean, object | true | See [UglifyJS documentation](http://lisperator.net/uglifyjs/compress). |
56-
| mangle | boolean, object | true | See below. |
57-
| beautify | boolean | false | Beautify output. |
58-
| 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. |
59-
| comments | boolean, RegExp, function(astNode, comment) -> boolean | Defaults to preserving comments containing `/*!`, `/**!`, `@preserve` or `@license`. | Comment related configuration. |
60-
| extractComments | boolean, RegExp, function (astNode, comment) -> boolean, object | false | Whether comments shall be extracted to a separate file, (see [details](https://github.com/webpack/webpack/commit/71933e979e51c533b432658d5e37917f9e71595a), since webpack 2.3.0) |
61-
| 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! |
62-
| test | RegExp, Array<RegExp> | <code>/\.js($&#124;\?)/i</code> | Test to match files against. |
63-
| include | RegExp, Array<RegExp> | | Test only `include` files. |
64-
| exclude | RegExp, Array<RegExp> | | Files to `exclude` from testing. |
65-
| warningsFilter | function(source) -> boolean | | Allow to filter uglify warnings (since webpack 2.3.0) |
66-
67-
<h2 align="center">Mangling</h2>
68-
69-
`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):
70-
71-
```javascript
72-
new UglifyJsPlugin({
73-
mangle: {
74-
// Skip mangling these
75-
except: ['$super', '$', 'exports', 'require']
76-
}
77-
})
41+
|Name|Type|Default|Description|
42+
|:--:|:--:|:-----:|:----------|
43+
|**`test`**|`{RegExp\|Array<RegExp>}`| <code>/\.js($&#124;\?)/i</code>|Test to match files against|
44+
|**`include`**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `include`|
45+
|**`exclude`**|`{RegExp\|Array<RegExp>}`|`undefined`|Files to `exclude`|
46+
|**`sourceMap`**|`{Boolean}`|`false`|Use SourceMaps to map error message locations to modules (This slows down the compilation) ⚠️ **`cheap-source-map` options don't work with this plugin**|
47+
|**`parallel`**|`{Boolean\|Object}`|`false`|Use multi-process parallel running and file cache to improve the build speed|
48+
|**`uglifyOptions`**|`{Object}`|[`{}`](https://github.com/webpack-contrib/uglifyjs-webpack-plugin/tree/readme#uglifyoptions)|`uglify` [Options](https://github.com/mishoo/UglifyJS2/tree/master#minify-options)|
49+
|**`extractComments`**|`{Boolean\|RegExp\|Function<(node, comment) -> {Boolean\|Object}>}`|`false`|Whether comments shall be extracted to a separate file, (see [details](https://github.com/webpack/webpack/commit/71933e979e51c533b432658d5e37917f9e71595a) (`webpack >= 2.3.0`)|
50+
|**`warningsFilter`**|`{Function(source) -> {Boolean}}`|``|Allow to filter uglify warnings|
51+
52+
### `test`
53+
54+
**webpack.config.js**
55+
```js
56+
[
57+
new UglifyJSPlugin({
58+
test: /\.js($&#124;\?)/i
59+
})
60+
]
61+
```
62+
63+
### `include`
64+
65+
**webpack.config.js**
66+
```js
67+
[
68+
new UglifyJSPlugin({
69+
include: /\/includes/
70+
})
71+
]
72+
```
73+
74+
### `exclude`
75+
76+
**webpack.config.js**
77+
```js
78+
[
79+
new UglifyJSPlugin({
80+
exclude: /\/excludes/
81+
})
82+
]
7883
```
7984

80-
`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.
85+
### `sourceMap`
8186

82-
> 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.
87+
**webpack.config.js**
88+
```js
89+
[
90+
new UglifyJSPlugin({
91+
sourceMap: true
92+
})
93+
]
94+
```
95+
96+
> ⚠️ **`cheap-source-map` options don't work with this plugin**
8397
84-
Example configuration, this will mangle both names and properties:
98+
### `parallel`
8599

86-
```javascript
87-
new UglifyJsPlugin({
88-
mangle: {
89-
props: true
90-
}
91-
})
100+
Enables parallelization (multi-process) with file caching
101+
102+
**webpack.config.js**
103+
```js
104+
[
105+
new UglifyJSPlugin({
106+
parallel: true
107+
})
108+
]
92109
```
93110

94-
<h2 align="center">Extracting Comments</h2>
111+
|Name|Type|Default|Description|
112+
|:--:|:--:|:-----:|:----------|
113+
|**`cache`**|`{Boolean}`|`node_modules/.cache/uglifyjs-webpack-plugin`|Enable file caching|
114+
|**`workers**|`{Boolean\|Object}`|`os.cpus().length - 1`|Maximum Number of concurrent runs|
115+
116+
**webpack.config.js**
117+
```js
118+
[
119+
new UglifyJSPlugin({
120+
parallel: {
121+
cache: true
122+
workers: 2 // for e.g
123+
}
124+
})
125+
]
126+
```
127+
128+
### [`uglifyOptions`](https://github.com/mishoo/UglifyJS2/tree/master#minify-options)
129+
130+
|Name|Type|Default|Description|
131+
|:--:|:--:|:-----:|:----------|
132+
|**`ie8`**|`{Boolean}`|`false`|Enable IE8 Support|
133+
|**[`parse`](https://github.com/mishoo/UglifyJS2/tree/master#parse-options)**|`{Object}`|`{}`|Additional Parse Options|
134+
|**[`mangle`](https://github.com/mishoo/UglifyJS2/tree/master#mangle-options)**|`{Boolean\|Object}`|`true`|Enable Name Mangling (See [Mangle Properties](https://github.com/mishoo/UglifyJS2/tree/master#mangle-properties-options) for advanced setups, use with ⚠️)|
135+
|**[`output`](https://github.com/mishoo/UglifyJS2/tree/master#output-options)**|`{Object}`|`{}`|Additional Output Options (The defaults are optimized for best compression)|
136+
|**[`compress`](https://github.com/mishoo/UglifyJS2/tree/master#compress-options)**|`{Boolean\|Object}`|`true`|Additional Compress Options|
137+
|**`warnings`**|`{Boolean}`|`false`|Display Warnings|
138+
|**`ecmascript`**|`{Number}`|``||
139+
140+
**webpack.config.js**
141+
```js
142+
[
143+
new UglifyJSPlugin({
144+
uglifyOptions: {
145+
ie8: false,
146+
parse: {...options},
147+
mangle: {
148+
...options,
149+
properties: {
150+
// mangle property options
151+
}
152+
},
153+
output: {
154+
comments: false,
155+
beautify: false,
156+
...options
157+
},
158+
compress: {...options},
159+
warnings: false,
160+
ecmascript: 7
161+
}
162+
})
163+
]
164+
```
165+
166+
### `extractComments`
95167

96168
The `extractComments` option can be
169+
97170
- `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`
98171
- regular expression (given as `RegExp` or `string`) or a `function (astNode, comment) -> boolean`:
99172
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.
100173
- an `object` consisting of the following keys, all optional:
101174
- `condition`: regular expression or function (see previous point)
102175
- `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.
103176
- `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.
177+
104178
Default: `/*! For license information please see foo.js.LICENSE */`
105179

180+
### `warningsFilter`
181+
182+
**webpack.config.js**
183+
```js
184+
[
185+
new UglifyJsPlugin({
186+
warningsFilter: (src) => true
187+
})
188+
]
189+
```
106190

107191
<h2 align="center">Maintainers</h2>
108192

109193
<table>
110194
<tbody>
111195
<tr>
112196
<td align="center">
113-
<img width="150" height="150"
114-
src="https://avatars3.githubusercontent.com/u/166921?v=3&s=150">
115-
</br>
116-
<a href="https://github.com/bebraw">Juho Vepsäläinen</a>
197+
<a href="https://github.com/hulkish">
198+
<img width="150" height="150" src="https://github.com/hulkish.png?size=150">
199+
</br>
200+
Steven Hargrove
201+
</a>
117202
</td>
118203
<td align="center">
119-
<img width="150" height="150"
120-
src="https://avatars2.githubusercontent.com/u/8420490?v=3&s=150">
121-
</br>
122-
<a href="https://github.com/d3viant0ne">Joshua Wiens</a>
204+
<a href="https://github.com/bebraw">
205+
<img width="150" height="150" src="https://github.com/bebraw.png?v=3&s=150">
206+
</br>
207+
Juho Vepsäläinen
208+
</a>
123209
</td>
124210
<td align="center">
125-
<img width="150" height="150"
126-
src="https://avatars3.githubusercontent.com/u/533616?v=3&s=150">
127-
</br>
128-
<a href="https://github.com/SpaceK33z">Kees Kluskens</a>
211+
<a href="https://github.com/d3viant0ne">
212+
<img width="150" height="150" src="https://github.com/d3viant0ne.png?v=3&s=150">
213+
</br>
214+
Joshua Wiens
215+
</a>
129216
</td>
130217
<td align="center">
131-
<img width="150" height="150"
132-
src="https://avatars3.githubusercontent.com/u/3408176?v=3&s=150">
133-
</br>
134-
<a href="https://github.com/TheLarkInn">Sean Larkin</a>
218+
<a href="https://github.com/michael-ciniawsky">
219+
<img width="150" height="150" src="https://github.com/michael-ciniawsky.png?v=3&s=150">
220+
</br>
221+
Michael Ciniawsky
222+
</a>
223+
</td>
224+
<td align="center">
225+
<a href="https://github.com/evilebottnawi">
226+
<img width="150" height="150" src="https://github.com/evilebottnawi.png?v=3&s=150">
227+
</br>
228+
Alexander Krasnoyarov
229+
</a>
135230
</td>
136231
</tr>
137232
<tbody>
@@ -141,17 +236,17 @@ Default: `/*! For license information please see foo.js.LICENSE */`
141236
[npm]: https://img.shields.io/npm/v/uglifyjs-webpack-plugin.svg
142237
[npm-url]: https://npmjs.com/package/uglifyjs-webpack-plugin
143238

239+
[node]: https://img.shields.io/node/v/uglifyjs-webpack-plugin.svg
240+
[node-url]: https://nodejs.org
241+
144242
[deps]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin.svg
145243
[deps-url]: https://david-dm.org/webpack-contrib/uglifyjs-webpack-plugin
146244

147-
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
148-
[chat-url]: https://gitter.im/webpack/webpack
149-
150245
[test]: https://secure.travis-ci.org/webpack-contrib/uglifyjs-webpack-plugin.svg
151246
[test-url]: http://travis-ci.org/webpack-contrib/uglifyjs-webpack-plugin
152247

153248
[cover]: https://codecov.io/gh/webpack-contrib/uglifyjs-webpack-plugin/branch/master/graph/badge.svg
154249
[cover-url]: https://codecov.io/gh/webpack-contrib/uglifyjs-webpack-plugin
155250

156-
[quality]: https://www.bithound.io/github/webpack-contrib/uglifyjs-webpack-plugin/badges/score.svg
157-
[quality-url]: https://www.bithound.io/github/webpack-contrib/uglifyjs-webpack-plugin
251+
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
252+
[chat-url]: https://gitter.im/webpack/webpack

0 commit comments

Comments
 (0)