minor #164 Trying out the new webpack-manifest-plugin (weaverryan)

This PR was squashed before being merged into the master branch (closes #164).

Discussion
----------

Trying out the new webpack-manifest-plugin

This is not ready to be merged yet... as we should wait for a stable release. But, let's see if the tests pass :). We originally "forked" this library internally due to 2 issues, both of which should have been fixed in version 2 of the library.

Should fix #140.

TODOS:

- Remove the old `webpack-manifest-plugin.js` file entirely and update paths to require the actual library instead of this

- Stop passing the `publicPath` option to the plugin, as this is not supported anymore (I believe it's just being ignored right now)

Commits
-------

6657a78 using the module directly and removing publicPath option, which is gone
9f7a866 Trying out the new webpack-manifest-plugin

Author: weaverryan

.eslintignore

@@ -9,7 +9,7 @@
 
 'use strict';
 
-const ManifestPlugin = require('../webpack/webpack-manifest-plugin');
+const ManifestPlugin = require('webpack-manifest-plugin');
 const PluginPriorities = require('./plugin-priorities');
 const applyOptionsCallback = require('../utils/apply-options-callback');
 
@@ -28,8 +28,6 @@ module.exports = function(plugins, webpackConfig) {
 
     const manifestPluginOptions = {
         basePath: manifestPrefix,
-        // guarantee the value uses the public path (or CDN public path)
-        publicPath: webpackConfig.getRealPublicPath(),
         // always write a manifest.json file, even with webpack-dev-server
         writeToFileEmit: true,
     };

lib/plugins/manifest.js

@@ -1,142 +1,15 @@
 /*
- * File is originally a direct copy from https://github.com/danethurber/webpack-manifest-plugin
- * at version 1.1.0.
+ * This file is part of the Symfony Webpack Encore package.
  *
- * The library is licensed as MIT.
+ * (c) Fabien Potencier <fabien@symfony.com>
  *
- * There was then one change made in the code below for
- * this library.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
 
-var path = require('path');
-var fse = require('fs-extra');
-var _ = require('lodash');
+'use strict';
 
-function ManifestPlugin(opts) {
-  this.opts = _.assign({
-    basePath: '',
-    publicPath: '',
-    fileName: 'manifest.json',
-    stripSrc: null,
-    transformExtensions: /^(gz|map)$/i,
-    writeToFileEmit: false,
-    cache: null
-  }, opts || {});
-}
+const logger = require('../logger');
+logger.deprecation('The lib/webpack/webpack-manifest-plugin.js module is deprecated: require the library directly now: require(\'webpack-manifest-plugin\').');
 
-ManifestPlugin.prototype.getFileType = function(str) {
-  str = str.replace(/\?.*/, '');
-  var split = str.split('.');
-  var ext = split.pop();
-  if (this.opts.transformExtensions.test(ext)) {
-    ext = split.pop() + '.' + ext;
-  }
-  return ext;
-};
-
-ManifestPlugin.prototype.apply = function(compiler) {
-  var outputName = this.opts.fileName;
-  var cache = this.opts.cache || {};
-  var moduleAssets = {};
-
-  compiler.plugin("compilation", function (compilation) {
-    compilation.plugin('module-asset', function (module, file) {
-      moduleAssets[file] = path.join(
-          path.dirname(file),
-          path.basename(module.userRequest)
-      );
-      /* *** MODIFICATION START *** */
-        // for Windows, we want the keys to use /, not \
-        // (and path.join will obviously use \ in Windows)
-        if (process.platform === 'win32') {
-            moduleAssets[file] = moduleAssets[file].replace(/\\/g, '/');
-        }
-      /* *** MODIFICATION END *** */
-    });
-  });
-
-  compiler.plugin('emit', function(compilation, compileCallback) {
-    var stats = compilation.getStats().toJson();
-    var manifest = {};
-
-    _.merge(manifest, compilation.chunks.reduce(function(memo, chunk) {
-      var chunkName = chunk.name ? chunk.name.replace(this.opts.stripSrc, '') : null;
-
-      // Map original chunk name to output files.
-      // For nameless chunks, just map the files directly.
-      return chunk.files.reduce(function(memo, file) {
-        // Don't add hot updates to manifest
-        if (file.indexOf('hot-update') >= 0) {
-          return memo;
-        }
-        if (chunkName) {
-          memo[chunkName + '.' + this.getFileType(file)] = file;
-        } else {
-          memo[file] = file;
-        }
-        return memo;
-      }.bind(this), memo);
-    }.bind(this), {}));
-
-    // module assets don't show up in assetsByChunkName.
-    // we're getting them this way;
-    _.merge(manifest, stats.assets.reduce(function(memo, asset) {
-      var name = moduleAssets[asset.name];
-      if (name) {
-        memo[name] = asset.name;
-      }
-      return memo;
-    }, {}));
-
-    /* *** MODIFICATION START *** */
-    if (this.opts.basePath && this.opts.publicPath) {
-      // A modification made to the plugin for Encore
-      manifest = _.reduce(manifest, function(memo, value, key) {
-        memo[this.opts.basePath + key] = this.opts.publicPath + value;
-        return memo;
-      }.bind(this), {});
-    /* *** MODIFICATION END *** */
-    } else if (this.opts.basePath) {
-      // Append optional basepath onto all references.
-      // This allows output path to be reflected in the manifest.
-      manifest = _.reduce(manifest, function(memo, value, key) {
-        memo[this.opts.basePath + key] = this.opts.basePath + value;
-        return memo;
-      }.bind(this), {});
-    } else if (this.opts.publicPath) {
-      // Similar to basePath but only affects the value (similar to how
-      // output.publicPath turns require('foo/bar') into '/public/foo/bar', see
-      // https://github.com/webpack/docs/wiki/configuration#outputpublicpath
-      manifest = _.reduce(manifest, function(memo, value, key) {
-        memo[key] = this.opts.publicPath + value;
-        return memo;
-      }.bind(this), {});
-    }
-
-    Object.keys(manifest).sort().forEach(function(key) {
-      cache[key] = manifest[key];
-    });
-
-    var json = JSON.stringify(cache, null, 2);
-
-    compilation.assets[outputName] = {
-      source: function() {
-        return json;
-      },
-      size: function() {
-        return json.length;
-      }
-    };
-
-    if (this.opts.writeToFileEmit) {
-      var outputFolder = compilation.options.output.path;
-      var outputFile = path.join(outputFolder, this.opts.fileName);
-
-      fse.outputFileSync(outputFile, json);
-    }
-
-    compileCallback();
-  }.bind(this));
-};
-
-module.exports = ManifestPlugin;
+module.exports = require('webpack-manifest-plugin');

lib/webpack/webpack-manifest-plugin.js

@@ -46,6 +46,7 @@
     "webpack": ">=2.2.0 <4",
     "webpack-chunk-hash": "^0.5.0",
     "webpack-dev-server": "^2.4.5",
+    "webpack-manifest-plugin": "v2.0.0-rc.1",
     "yargs": "^8.0.1"
   },
   "devDependencies": {

package.json

@@ -14,7 +14,7 @@ const WebpackConfig = require('../lib/WebpackConfig');
 const RuntimeConfig = require('../lib/config/RuntimeConfig');
 const configGenerator = require('../lib/config-generator');
 const ExtractTextPlugin = require('extract-text-webpack-plugin');
-const ManifestPlugin = require('./../lib/webpack/webpack-manifest-plugin');
+const ManifestPlugin = require('webpack-manifest-plugin');
 const CleanWebpackPlugin = require('clean-webpack-plugin');
 const webpack = require('webpack');
 
@@ -153,7 +153,6 @@ describe('The config-generator function', () => {
 
             expect(actualConfig.output.publicPath).to.equal('/build/');
             const manifestPlugin = findPlugin(ManifestPlugin, actualConfig.plugins);
-            expect(manifestPlugin.opts.publicPath).to.equal('/build/');
             // basePath matches publicPath, *without* the opening slash
             // we do that by convention: keys do not start with /
             expect(manifestPlugin.opts.basePath).to.equal('build/');
@@ -171,7 +170,6 @@ describe('The config-generator function', () => {
 
             expect(actualConfig.output.publicPath).to.equal('/subdirectory/build/');
             const manifestPlugin = findPlugin(ManifestPlugin, actualConfig.plugins);
-            expect(manifestPlugin.opts.publicPath).to.equal('/subdirectory/build/');
             // base path matches manifestKeyPrefix + trailing slash
             // the opening slash is kept, since the user is overriding this setting
             expect(manifestPlugin.opts.basePath).to.equal('/build/');
@@ -187,7 +185,6 @@ describe('The config-generator function', () => {
             const actualConfig = configGenerator(config);
 
             const manifestPlugin = findPlugin(ManifestPlugin, actualConfig.plugins);
-            expect(manifestPlugin.opts.publicPath).to.equal('/build/');
             expect(manifestPlugin.opts.basePath).to.equal('');
         });
     });

test/config-generator.js

@@ -10,7 +10,7 @@
 'use strict';
 
 const expect = require('chai').expect;
-const ManifestPlugin = require('../../lib/webpack/webpack-manifest-plugin');
+const ManifestPlugin = require('webpack-manifest-plugin');
 const WebpackConfig = require('../../lib/WebpackConfig');
 const RuntimeConfig = require('../../lib/config/RuntimeConfig');
 const manifestPluginUtil = require('../../lib/plugins/manifest');
@@ -34,7 +34,6 @@ describe('plugins/manifest', () => {
         expect(plugins.length).to.equal(1);
         expect(plugins[0].plugin).to.be.instanceof(ManifestPlugin);
         expect(plugins[0].plugin.opts.fileName).to.equal('manifest.json');
-        expect(plugins[0].plugin.opts.publicPath).to.equal('/foo/');
     });
 
     it('with options callback', () => {
@@ -51,9 +50,6 @@ describe('plugins/manifest', () => {
 
         // Allows to override default options
         expect(plugins[0].plugin.opts.fileName).to.equal('bar');
-
-        // Doesn't remove default options
-        expect(plugins[0].plugin.opts.publicPath).to.equal('/foo/');
     });
 
     it('with options callback that returns an object', () => {

test/plugins/manifest.js

@@ -3,8 +3,8 @@
 
 
 "@types/node@*":
-  version "9.6.4"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-9.6.4.tgz#0ef7b4cfc3499881c81e0ea1ce61a23f6f4f5b42"
+  version "9.6.5"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-9.6.5.tgz#ee700810fdf49ac1c399fc5980b7559b3e5a381d"
 
 "@types/tapable@^0":
   version "0.2.5"
@@ -1229,12 +1229,12 @@ caniuse-api@^1.5.2:
     lodash.uniq "^4.5.0"
 
 caniuse-db@^1.0.30000529, caniuse-db@^1.0.30000634, caniuse-db@^1.0.30000639:
-  version "1.0.30000828"
-  resolved "https://registry.yarnpkg.com/caniuse-db/-/caniuse-db-1.0.30000828.tgz#ed6d6f03b5a81fb291c3c0e088828b11a70948bf"
+  version "1.0.30000830"
+  resolved "https://registry.yarnpkg.com/caniuse-db/-/caniuse-db-1.0.30000830.tgz#6e45255b345649fd15ff59072da1e12bb3de2f13"
 
 caniuse-lite@^1.0.30000792:
-  version "1.0.30000828"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000828.tgz#048f98de213f7a3c047bf78a9523c611855d4fdd"
+  version "1.0.30000830"
+  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000830.tgz#cb96b8a2dd3cbfe04acea2af3c4e894249095328"
 
 caseless@~0.11.0:
   version "0.11.0"
@@ -2710,6 +2710,16 @@ friendly-errors-webpack-plugin@^1.6.1:
     error-stack-parser "^2.0.0"
     string-width "^2.0.0"
 
+fs-extra@^0.30.0:
+  version "0.30.0"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-0.30.0.tgz#f233ffcc08d4da7d432daa449776989db1df93f0"
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^2.1.0"
+    klaw "^1.0.0"
+    path-is-absolute "^1.0.0"
+    rimraf "^2.2.8"
+
 fs-extra@^2.0.0:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-2.1.2.tgz#046c70163cef9aad46b0e4a7fa467fb22d71de35"
@@ -2900,7 +2910,7 @@ globule@^1.0.0:
     lodash "~4.17.4"
     minimatch "~3.0.2"
 
-graceful-fs@^4.1.2, graceful-fs@^4.1.6:
+graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.1.9:
   version "4.1.11"
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
 
@@ -3756,6 +3766,12 @@ kind-of@^6.0.0, kind-of@^6.0.2:
   version "6.0.2"
   resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.2.tgz#01146b36a6218e64e58f3a8d66de5d7fc6f6d051"
 
+klaw@^1.0.0:
+  version "1.3.1"
+  resolved "https://registry.yarnpkg.com/klaw/-/klaw-1.3.1.tgz#4088433b46b3b1ba259d78785d8e96f73ba02439"
+  optionalDependencies:
+    graceful-fs "^4.1.9"
+
 lazy-cache@^1.0.3:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/lazy-cache/-/lazy-cache-1.0.4.tgz#a1d78fc3a50474cb80845d3b3b6e1da49a446e8e"
@@ -4238,6 +4254,10 @@ mute-stream@0.0.5:
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.5.tgz#8fbfabb0a98a253d3184331f9e8deb7372fac6c0"
 
+mutexify@1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/mutexify/-/mutexify-1.0.1.tgz#9880206795d89e75efc1bcb4b4f52ebbd796e5e7"
+
 nan@^2.10.0, nan@^2.3.0:
   version "2.10.0"
   resolved "https://registry.yarnpkg.com/nan/-/nan-2.10.0.tgz#96d0cd610ebd58d4b4de9cc0c6828cda99c7548f"
@@ -6772,6 +6792,14 @@ webpack-dev-server@^2.4.5:
     webpack-dev-middleware "1.12.2"
     yargs "6.6.0"
 
+webpack-manifest-plugin@v2.0.0-rc.1:
+  version "2.0.0-rc.1"
+  resolved "https://registry.yarnpkg.com/webpack-manifest-plugin/-/webpack-manifest-plugin-2.0.0-rc.1.tgz#82b03afd05a308a36a6066f1c37ac9ff1c9d5e8a"
+  dependencies:
+    fs-extra "^0.30.0"
+    lodash ">=3.5 <5"
+    mutexify "1.0.1"
+
 webpack-notifier@^1.5.0:
   version "1.6.0"
   resolved "https://registry.yarnpkg.com/webpack-notifier/-/webpack-notifier-1.6.0.tgz#ffac8e55ff8c469752b8c1bbb011a16f10986e02"