You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 5, 2019. It is now read-only.
<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/harmony">UglifyJS v3</a> to minify your JavaScript<p>
16
16
</div>
17
17
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
| 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($|\?)/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. |
| parallel | boolean, object | false | Use multi-process parallel running and file cache to improve the build speed. |
67
-
68
-
<h2align="center">Mangling</h2>
69
-
70
-
`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):
71
-
72
-
```javascript
73
-
newUglifyJsPlugin({
74
-
mangle: {
75
-
// Skip mangling these
76
-
except: ['$super', '$', 'exports', 'require']
77
-
}
78
-
})
41
+
|Name|Type|Default|Description|
42
+
|:--:|:--:|:-----:|:----------|
43
+
|**`test`**|`{RegExp\|Array<RegExp>}`| <code>/\.js($|\?)/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
+
|**`parallel`**|`{Boolean\|Object}`|`false`|Use multi-process parallel running and file cache to improve the build speed|
47
+
|**`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**|
|**`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
+
newUglifyJSPlugin({
58
+
test:/\.js($|\?)/i
59
+
})
60
+
]
61
+
```
62
+
63
+
### `include`
64
+
65
+
**webpack.config.js**
66
+
```js
67
+
[
68
+
newUglifyJSPlugin({
69
+
include:/\/includes/
70
+
})
71
+
]
79
72
```
80
73
81
-
`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.
74
+
### `exclude`
75
+
76
+
**webpack.config.js**
77
+
```js
78
+
[
79
+
newUglifyJSPlugin({
80
+
exclude:/\/excludes/
81
+
})
82
+
]
83
+
```
82
84
83
-
> 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.
85
+
### `parallel`
84
86
85
-
Example configuration, this will mangle both names and properties:
|**`workers`**|`{Boolean\|Object}`|`os.cpus().length - 1`|Number of concurrent runs, default is the `maximum`|
100
+
101
+
**webpack.config.js**
102
+
```js
103
+
[
104
+
newUglifyJSPlugin({
105
+
parallel: {
106
+
cache:true
107
+
workers:2// for e.g
108
+
}
109
+
})
110
+
]
93
111
```
94
112
95
-
<h2align="center">Extracting Comments</h2>
113
+
> ℹ️ Parallelization can speedup your build significantly and is therefore **highly recommended**
96
114
97
-
The `extractComments` option can be
98
-
-`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`
99
-
- regular expression (given as `RegExp` or `string`) or a `function (astNode, comment) -> boolean`:
100
-
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.
101
-
- an `object` consisting of the following keys, all optional:
102
-
-`condition`: regular expression or function (see previous point)
103
-
-`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.
104
-
-`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.
105
-
Default: `/*! For license information please see foo.js.LICENSE */`
115
+
### `sourceMap`
116
+
117
+
**webpack.config.js**
118
+
```js
119
+
[
120
+
newUglifyJSPlugin({
121
+
sourceMap:true
122
+
})
123
+
]
124
+
```
125
+
126
+
> ⚠️ **`cheap-source-map` options don't work with this plugin**
|**[`mangle`](https://github.com/mishoo/UglifyJS2/tree/harmony#mangle-options)**|`{Boolean\|Object}`|`true`|Enable Name Mangling (See [Mangle Properties](https://github.com/mishoo/UglifyJS2/tree/harmony#mangle-properties-options) for advanced setups, use with ⚠️)|
136
+
|**[`output`](https://github.com/mishoo/UglifyJS2/tree/harmony#output-options)**|`{Object}`|`{}`|Additional Output Options (The defaults are optimized for best compression)|
-`true`: Enable multi-process parallel running with file cache
112
-
- an `object` consisting of the following keys, all optional:
113
-
-`workers`: The maximum number of concurrent runs. If it is `true`, it is equal to `require('os').cpus().length - 1`.
114
-
-`cache`: Enable file caching. If it is `true`, it is equal to `"node_modules/.cache/uglifyjs-webpack-plugin"`.
170
+
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`
171
+
172
+
**`{RegExp|String}` or `{Function<(node, comment) -> {Boolean}>}`**
173
+
174
+
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.
175
+
176
+
**`{Object}`**
177
+
178
+
|Name|Type|Default|Description|
179
+
|:--:|:--:|:-----:|:----------|
180
+
|**`condition`**|`{Regex\|Function}`|``|Regular Expression or function (see previous point)|
181
+
|**`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|
182
+
|**`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|
0 commit comments