feat: custom minify function

alexander-akait · alexander-akait · commit 933e07555b06 · 2018-07-03T16:35:56.000+03:00
diff --git a/README.md b/README.md
@@ -50,6 +50,7 @@ module.exports = {
 |**`cacheKeys`**|`{Function(defaultCacheKeys, file) -> {Object}}`|`defaultCacheKeys => defaultCacheKeys`|Allows you to override default cache keys|
 |**`parallel`**|`{Boolean\|Number}`|`false`|Use multi-process parallel running 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**|
+|**`minify`**|`{Function}`|`(file, uglifyOptions) => uglify.minify(file, uglifyOptions)`|Allows you to override default minify function|
 |**`uglifyOptions`**|`{Object}`|[`{...defaults}`](https://github.com/webpack-contrib/uglifyjs-webpack-plugin/tree/master#uglifyoptions)|`uglify` [Options](https://github.com/mishoo/UglifyJS2/tree/harmony#minify-options)|
 |**`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`)|
 |**`warningsFilter`**|`{Function(source) -> {Boolean}}`|`() => true`|Allow to filter uglify warnings|
@@ -189,6 +190,57 @@ Number of concurrent runs.
 
 > ⚠️ **`cheap-source-map` options don't work with this plugin**
 
+### `minify`
+
+**webpack.config.js**
+```js
+[
+  new UglifyJsPlugin({
+     minify(file, uglifyOptions) {
+        return uglifyCompatibilityPackage.minify(file, uglifyOptions);
+      }
+  })
+]
+```
+
+By default plugin use `uglify-es.minify` function.
+
+Examples:
+
+#### `uglify-js`
+
+```bash
+npm i -D uglify-js
+```
+
+**webpack.config.js**
+```js
+[
+  new UglifyJsPlugin({
+     minify(file, uglifyOptions) {
+       return require('uglify-js').minify(file, uglifyOptions);
+     }
+  })
+]
+```
+
+#### `terser`
+
+```bash
+npm i -D terser
+```
+
+**webpack.config.js**
+```js
+[
+  new UglifyJsPlugin({
+     minify(file, uglifyOptions) {
+       return require('terser').minify(file, uglifyOptions);
+     }
+  })
+]
+```
+
 ### [`uglifyOptions`](https://github.com/mishoo/UglifyJS2/tree/harmony#minify-options)
 
 |Name|Type|Default|Description|
diff --git a/package.json b/package.json
@@ -58,7 +58,9 @@
     "pre-commit": "^1.2.2",
     "standard-version": "^4.3.0",
     "webpack": "^3.10.0",
-    "webpack-defaults": "^1.6.0"
+    "webpack-defaults": "^1.6.0",
+    "uglify-js": "^3.4.2",
+    "terser": "^3.7.6"
   },
   "peerDependencies": {
     "webpack": "^2.0.0 || ^3.0.0 || ^4.0.0"
diff --git a/src/index.js b/src/index.js
@@ -8,8 +8,9 @@ import { SourceMapSource, RawSource, ConcatSource } from 'webpack-sources';
 import RequestShortener from 'webpack/lib/RequestShortener';
 import ModuleFilenameHelpers from 'webpack/lib/ModuleFilenameHelpers';
 import validateOptions from 'schema-utils';
+import uglify from 'uglify-es';
 import schema from './options.json';
-import Uglify from './uglify';
+import Runner from './uglify/Runner';
 import versions from './uglify/versions';
 import utils from './utils';
 
@@ -20,6 +21,10 @@ class UglifyJsPlugin {
     validateOptions(schema, options, 'UglifyJs Plugin');
 
     const {
+      minify = (file, uglifyOptions) => uglify.minify(
+        file,
+        uglifyOptions,
+      ),
       uglifyOptions = {},
       test = /\.js(\?.*)?$/i,
       warningsFilter = () => true,
@@ -42,6 +47,7 @@ class UglifyJsPlugin {
       parallel,
       include,
       exclude,
+      minify,
       uglifyOptions: {
         compress: {
           inline: 1,
@@ -114,7 +120,7 @@ class UglifyJsPlugin {
     };
 
     const optimizeFn = (compilation, chunks, callback) => {
-      const uglify = new Uglify({
+      const runner = new Runner({
         cache: this.options.cache,
         parallel: this.options.parallel,
       });
@@ -169,6 +175,7 @@ class UglifyJsPlugin {
               commentsFile,
               extractComments: this.options.extractComments,
               uglifyOptions: this.options.uglifyOptions,
+              minify: this.options.minify,
             };
 
             if (this.options.cache) {
@@ -196,7 +203,7 @@ class UglifyJsPlugin {
           }
         });
 
-      uglify.runTasks(tasks, (tasksError, results) => {
+      runner.runTasks(tasks, (tasksError, results) => {
         if (tasksError) {
           compilation.errors.push(tasksError);
           return;
@@ -294,7 +301,7 @@ class UglifyJsPlugin {
           }
         });
 
-        uglify.exit();
+        runner.exit();
 
         callback();
       });
diff --git a/src/options.json b/src/options.json
@@ -19,6 +19,9 @@
         { "type": "integer" }
       ]
     },
+    "minify": {
+      "instanceof": "Function"
+    },
     "warningsFilter": {},
     "extractComments": {},
     "sourceMap": {
diff --git a/src/uglify/Runner.js b/src/uglify/Runner.js
@@ -12,7 +12,7 @@ try {
   workerFile = require.resolve('../../dist/uglify/worker');
 } catch (e) { } // eslint-disable-line no-empty
 
-export default class {
+export default class Runner {
   constructor(options = {}) {
     const { cache, parallel } = options;
     this.cacheDir = cache === true ? findCacheDir({ name: 'uglifyjs-webpack-plugin' }) : cache;
diff --git a/src/uglify/minify.js b/src/uglify/minify.js
@@ -1,8 +1,6 @@
 /* eslint-disable
   arrow-body-style
 */
-import uglify from 'uglify-es';
-
 const buildUglifyOptions = ({
   ecma,
   warnings,
@@ -127,9 +125,9 @@ const buildComments = (options, uglifyOptions, extractedComments) => {
 };
 
 const minify = (options) => {
-  const { file, input, inputSourceMap, extractComments } = options;
+  const { file, input, inputSourceMap, extractComments, minify: minifyFn } = options;
   // Copy uglify options
-  const uglifyOptions = buildUglifyOptions(options.uglifyOptions);
+  const uglifyOptions = minify ? options.uglifyOptions : buildUglifyOptions(options.uglifyOptions);
 
   // Add source map data
   if (inputSourceMap) {
@@ -148,7 +146,7 @@ const minify = (options) => {
     );
   }
 
-  const { error, map, code, warnings } = uglify.minify(
+  const { error, map, code, warnings } = minifyFn(
     { [file]: input },
     uglifyOptions,
   );
diff --git a/test/__snapshots__/extract-comments-options.test.js.snap b/test/__snapshots__/extract-comments-options.test.js.snap
@@ -4,6 +4,11 @@ exports[`when options.extractComments normalizes when options.extractComments is
 
 exports[`when options.extractComments normalizes when options.extractComments is boolean - "true": test.js 1`] = `"var foo=1;"`;
 
+exports[`when options.extractComments normalizes when options.extractComments is boolean - "true": test.js.LICENSE 1`] = `
+"/*! Legal Comment */
+"
+`;
+
 exports[`when options.extractComments normalizes when options.extractComments is boolean - "true": test1.js 1`] = `
 "/*! For license information please see test1.js.LICENSE */
 var foo=1;"
@@ -69,6 +74,11 @@ exports[`when options.extractComments normalizes when options.extractComments is
 
 exports[`when options.extractComments normalizes when options.extractComments is regex: test.js 1`] = `"var foo=1;"`;
 
+exports[`when options.extractComments normalizes when options.extractComments is regex: test.js.LICENSE 1`] = `
+"// foo
+"
+`;
+
 exports[`when options.extractComments normalizes when options.extractComments is regex: test1.js 1`] = `
 "/*! For license information please see test1.js.LICENSE */
 var foo=1;"
diff --git a/test/__snapshots__/minify.test.js.snap b/test/__snapshots__/minify.test.js.snap
@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`when applied with minify option matches snapshot for \`terser\` minifier: errors 1`] = `Array []`;
+
+exports[`when applied with minify option matches snapshot for \`terser\` minifier: main.js 1`] = `"webpackJsonp([0],[function(t,e,s){\\"use strict\\";Object.defineProperty(e,\\"__esModule\\",{value:!0});e.default=class{constructor(t,e){this.x=t,this.y=e}static distance(t,e){const s=t.x-e.x,c=t.y-e.y;return Math.hypot(s,c)}}}],[0]);"`;
+
+exports[`when applied with minify option matches snapshot for \`terser\` minifier: manifest.js 1`] = `"!function(r){var n=window.webpackJsonp;window.webpackJsonp=function(e,u,c){for(var f,i,p,a=0,l=[];a<e.length;a++)i=e[a],o[i]&&l.push(o[i][0]),o[i]=0;for(f in u)Object.prototype.hasOwnProperty.call(u,f)&&(r[f]=u[f]);for(n&&n(e,u,c);l.length;)l.shift()();if(c)for(a=0;a<c.length;a++)p=t(t.s=c[a]);return p};var e={},o={1:0};function t(n){if(e[n])return e[n].exports;var o=e[n]={i:n,l:!1,exports:{}};return r[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=r,t.c=e,t.d=function(r,n,e){t.o(r,n)||Object.defineProperty(r,n,{configurable:!1,enumerable:!0,get:e})},t.n=function(r){var n=r&&r.__esModule?function(){return r.default}:function(){return r};return t.d(n,\\"a\\",n),n},t.o=function(r,n){return Object.prototype.hasOwnProperty.call(r,n)},t.p=\\"\\",t.oe=function(r){throw console.error(r),r}}([]);"`;
+
+exports[`when applied with minify option matches snapshot for \`terser\` minifier: warnings 1`] = `Array []`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-es\` minifier: errors 1`] = `Array []`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-es\` minifier: main.js 1`] = `"webpackJsonp([0],[function(t,e,s){\\"use strict\\";Object.defineProperty(e,\\"__esModule\\",{value:!0});e.default=class{constructor(t,e){this.x=t,this.y=e}static distance(t,e){const s=t.x-e.x,c=t.y-e.y;return Math.hypot(s,c)}}}],[0]);"`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-es\` minifier: manifest.js 1`] = `"!function(r){var n=window.webpackJsonp;window.webpackJsonp=function(e,u,c){for(var f,i,p,a=0,l=[];a<e.length;a++)i=e[a],o[i]&&l.push(o[i][0]),o[i]=0;for(f in u)Object.prototype.hasOwnProperty.call(u,f)&&(r[f]=u[f]);for(n&&n(e,u,c);l.length;)l.shift()();if(c)for(a=0;a<c.length;a++)p=t(t.s=c[a]);return p};var e={},o={1:0};function t(n){if(e[n])return e[n].exports;var o=e[n]={i:n,l:!1,exports:{}};return r[n].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=r,t.c=e,t.d=function(r,n,e){t.o(r,n)||Object.defineProperty(r,n,{configurable:!1,enumerable:!0,get:e})},t.n=function(r){var n=r&&r.__esModule?function(){return r.default}:function(){return r};return t.d(n,\\"a\\",n),n},t.o=function(r,n){return Object.prototype.hasOwnProperty.call(r,n)},t.p=\\"\\",t.oe=function(r){throw console.error(r),r}}([]);"`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-es\` minifier: warnings 1`] = `Array []`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-js\` minifier: errors 1`] = `Array []`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-js\` minifier: main.js 1`] = `"webpackJsonp([0],[function(e,n){e.exports=function(){var baz=document.getElementById(\\"root\\").innerHTML;document.getElementById(\\"demo\\").innerHTML=\\"Paragraph changed.\\"+baz}}],[0]);"`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-js\` minifier: manifest.js 1`] = `"!function(i){var p=window.webpackJsonp;window.webpackJsonp=function(r,n,e){for(var o,t,u,c=0,f=[];c<r.length;c++)t=r[c],a[t]&&f.push(a[t][0]),a[t]=0;for(o in n)Object.prototype.hasOwnProperty.call(n,o)&&(i[o]=n[o]);for(p&&p(r,n,e);f.length;)f.shift()();if(e)for(c=0;c<e.length;c++)u=l(l.s=e[c]);return u};var e={},a={1:0};function l(r){if(e[r])return e[r].exports;var n=e[r]={i:r,l:!1,exports:{}};return i[r].call(n.exports,n,n.exports,l),n.l=!0,n.exports}l.m=i,l.c=e,l.d=function(r,n,e){l.o(r,n)||Object.defineProperty(r,n,{configurable:!1,enumerable:!0,get:e})},l.n=function(r){var n=r&&r.__esModule?function(){return r.default}:function(){return r};return l.d(n,\\"a\\",n),n},l.o=function(r,n){return Object.prototype.hasOwnProperty.call(r,n)},l.p=\\"\\",l.oe=function(r){throw console.error(r),r}}([]);"`;
+
+exports[`when applied with minify option matches snapshot for \`uglify-js\` minifier: warnings 1`] = `Array []`;
diff --git a/test/fixtures/minify/terser.js b/test/fixtures/minify/terser.js
@@ -0,0 +1,15 @@
+class Point {
+  constructor(x, y) {
+    this.x = x;
+    this.y = y;
+  }
+
+  static distance(a, b) {
+    const dx = a.x - b.x;
+    const dy = a.y - b.y;
+
+    return Math.hypot(dx, dy);
+  }
+}
+
+export default Point;
diff --git a/test/fixtures/minify/uglify-es.js b/test/fixtures/minify/uglify-es.js
@@ -0,0 +1,15 @@
+class Point {
+  constructor(x, y) {
+    this.x = x;
+    this.y = y;
+  }
+
+  static distance(a, b) {
+    const dx = a.x - b.x;
+    const dy = a.y - b.y;
+
+    return Math.hypot(dx, dy);
+  }
+}
+
+export default Point;
diff --git a/test/fixtures/minify/uglify-js.js b/test/fixtures/minify/uglify-js.js
@@ -0,0 +1,7 @@
+function myFunction() {
+  var baz = document.getElementById("root").innerHTML;
+
+  document.getElementById("demo").innerHTML = "Paragraph changed." + baz;
+}
+
+module.exports = myFunction;
diff --git a/test/minify.test.js b/test/minify.test.js
@@ -0,0 +1,118 @@
+import uglifyJs from 'uglify-js';
+import uglifyEs from 'uglify-es';
+import terser from 'terser';
+import UglifyJsPlugin from '../src';
+import { cleanErrorStack, compile, createCompiler } from './helpers';
+
+describe('when applied with minify option', () => {
+  it('matches snapshot for `uglify-js` minifier', () => {
+    const compiler = createCompiler({
+      entry: `${__dirname}/fixtures/minify/uglify-js.js`,
+      output: {
+        path: `${__dirname}/dist-uglify-js`,
+        filename: '[name].js',
+        chunkFilename: '[id].[name].js',
+      },
+    });
+
+    new UglifyJsPlugin({
+      minify(file, uglifyOptions) {
+        return uglifyJs.minify(file, uglifyOptions);
+      },
+      uglifyOptions: {
+        mangle: {
+          reserved: ['baz'],
+        },
+      },
+    }).apply(compiler);
+
+    return compile(compiler)
+      .then((stats) => {
+        const errors = stats.compilation.errors.map(cleanErrorStack);
+        const warnings = stats.compilation.warnings.map(cleanErrorStack);
+
+        expect(errors).toMatchSnapshot('errors');
+        expect(warnings).toMatchSnapshot('warnings');
+
+        for (const file in stats.compilation.assets) {
+          if (Object.prototype.hasOwnProperty.call(stats.compilation.assets, file)) {
+            expect(stats.compilation.assets[file].source()).toMatchSnapshot(file);
+          }
+        }
+      });
+  });
+
+  it('matches snapshot for `uglify-es` minifier', () => {
+    const compiler = createCompiler({
+      entry: `${__dirname}/fixtures/minify/uglify-es.js`,
+      output: {
+        path: `${__dirname}/dist-uglify-es`,
+        filename: '[name].js',
+        chunkFilename: '[id].[name].js',
+      },
+    });
+
+    new UglifyJsPlugin({
+      minify(file, uglifyOptions) {
+        return uglifyEs.minify(file, uglifyOptions);
+      },
+      uglifyOptions: {
+        mangle: {
+          reserved: ['baz'],
+        },
+      },
+    }).apply(compiler);
+
+    return compile(compiler)
+      .then((stats) => {
+        const errors = stats.compilation.errors.map(cleanErrorStack);
+        const warnings = stats.compilation.warnings.map(cleanErrorStack);
+
+        expect(errors).toMatchSnapshot('errors');
+        expect(warnings).toMatchSnapshot('warnings');
+
+        for (const file in stats.compilation.assets) {
+          if (Object.prototype.hasOwnProperty.call(stats.compilation.assets, file)) {
+            expect(stats.compilation.assets[file].source()).toMatchSnapshot(file);
+          }
+        }
+      });
+  });
+
+  it('matches snapshot for `terser` minifier', () => {
+    const compiler = createCompiler({
+      entry: `${__dirname}/fixtures/minify/terser`,
+      output: {
+        path: `${__dirname}/dist-terser`,
+        filename: '[name].js',
+        chunkFilename: '[id].[name].js',
+      },
+    });
+
+    new UglifyJsPlugin({
+      minify(file, uglifyOptions) {
+        return terser.minify(file, uglifyOptions);
+      },
+      uglifyOptions: {
+        mangle: {
+          reserved: ['baz'],
+        },
+      },
+    }).apply(compiler);
+
+    return compile(compiler)
+      .then((stats) => {
+        const errors = stats.compilation.errors.map(cleanErrorStack);
+        const warnings = stats.compilation.warnings.map(cleanErrorStack);
+
+        expect(errors).toMatchSnapshot('errors');
+        expect(warnings).toMatchSnapshot('warnings');
+
+        for (const file in stats.compilation.assets) {
+          if (Object.prototype.hasOwnProperty.call(stats.compilation.assets, file)) {
+            expect(stats.compilation.assets[file].source()).toMatchSnapshot(file);
+          }
+        }
+      });
+  });
+});
