webpack 4.9.1 → 4.9.2

package/lib/AmdMainTemplatePlugin.js

@@ -8,11 +8,21 @@
 const { ConcatSource } = require("webpack-sources");
 const Template = require("./Template");
 
+/** @typedef {import("./Compilation")} Compilation */
+
 class AmdMainTemplatePlugin {
+	/**
+	 * @param {string} name the library name
+	 */
 	constructor(name) {
+		/** @type {string} */
 		this.name = name;
 	}
 
+	/**
+	 * @param {Compilation} compilation the compilation instance
+	 * @returns {void}
+	 */
 	apply(compilation) {
 		const { mainTemplate, chunkTemplate } = compilation;
 

package/lib/AsyncDependencyToInitialChunkError.js

@@ -6,7 +6,15 @@
 
 const WebpackError = require("./WebpackError");
 
-module.exports = class AsyncDependencyToInitialChunkError extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class AsyncDependencyToInitialChunkError extends WebpackError {
+	/**
+	 * Creates an instance of AsyncDependencyToInitialChunkError.
+	 * @param {string} chunkName Name of Chunk
+	 * @param {Module} module module tied to dependency
+	 * @param {TODO} loc location of dependency
+	 */
 	constructor(chunkName, module, loc) {
 		super();
 
@@ -18,4 +26,6 @@ module.exports = class AsyncDependencyToInitialChunkError extends WebpackError {
 
 		Error.captureStackTrace(this, this.constructor);
 	}
-};
+}
+
+module.exports = AsyncDependencyToInitialChunkError;

package/lib/CaseSensitiveModulesWarning.js

@@ -6,7 +6,13 @@
 
 const WebpackError = require("./WebpackError");
 
-module.exports = class CaseSensitiveModulesWarning extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class CaseSensitiveModulesWarning extends WebpackError {
+	/**
+	 * Creates an instance of CaseSensitiveModulesWarning.
+	 * @param {Module[]} modules modules that were detected
+	 */
 	constructor(modules) {
 		super();
 
@@ -23,6 +29,11 @@ ${modulesList}`;
 		Error.captureStackTrace(this, this.constructor);
 	}
 
+	/**
+	 * @private
+	 * @param {Module[]} modules the modules to be sorted
+	 * @returns {Module[]} sorted version of original modules
+	 */
 	_sort(modules) {
 		return modules.slice().sort((a, b) => {
 			a = a.identifier();
@@ -36,6 +47,11 @@ ${modulesList}`;
 		});
 	}
 
+	/**
+	 * @private
+	 * @param {Module[]} modules each module from throw
+	 * @returns {string} each message from provided moduels
+	 */
 	_moduleMessages(modules) {
 		return modules
 			.map(m => {
@@ -50,4 +66,6 @@ ${modulesList}`;
 			})
 			.join("\n");
 	}
-};
+}
+
+module.exports = CaseSensitiveModulesWarning;

package/lib/ExportPropertyMainTemplatePlugin.js

@@ -6,15 +6,28 @@
 
 const { ConcatSource } = require("webpack-sources");
 
+/** @typedef {import("./Compilation")} Compilation */
+
+/**
+ * @param {string[]} accessor the accessor to convert to path
+ * @returns {string} the path
+ */
 const accessorToObjectAccess = accessor => {
 	return accessor.map(a => `[${JSON.stringify(a)}]`).join("");
 };
 
 class ExportPropertyMainTemplatePlugin {
+	/**
+	 * @param {string|string[]} property the name of the property to export
+	 */
 	constructor(property) {
 		this.property = property;
 	}
 
+	/**
+	 * @param {Compilation} compilation the compilation instance
+	 * @returns {void}
+	 */
 	apply(compilation) {
 		const { mainTemplate, chunkTemplate } = compilation;
 

package/lib/LibraryTemplatePlugin.js

@@ -6,30 +6,45 @@
 
 const SetVarMainTemplatePlugin = require("./SetVarMainTemplatePlugin");
 
+/** @typedef {import("./Compiler")} Compiler */
+
+/**
+ * @param {string[]} accessor the accessor to convert to path
+ * @returns {string} the path
+ */
 const accessorToObjectAccess = accessor => {
-	return accessor
-		.map(a => {
-			return `[${JSON.stringify(a)}]`;
-		})
-		.join("");
+	return accessor.map(a => `[${JSON.stringify(a)}]`).join("");
 };
 
-const accessorAccess = (base, accessor, joinWith) => {
-	accessor = [].concat(accessor);
-	return accessor
-		.map((a, idx) => {
-			a = base
-				? base + accessorToObjectAccess(accessor.slice(0, idx + 1))
-				: accessor[0] + accessorToObjectAccess(accessor.slice(1, idx + 1));
-			if (idx === accessor.length - 1) return a;
+/**
+ * @param {string=} base the path prefix
+ * @param {string|string[]} accessor the accessor
+ * @param {string=} joinWith the element separator
+ * @returns {string} the path
+ */
+const accessorAccess = (base, accessor, joinWith = "; ") => {
+	const accessors = Array.isArray(accessor) ? accessor : [accessor];
+	return accessors
+		.map((_, idx) => {
+			const a = base
+				? base + accessorToObjectAccess(accessors.slice(0, idx + 1))
+				: accessors[0] + accessorToObjectAccess(accessors.slice(1, idx + 1));
+			if (idx === accessors.length - 1) return a;
 			if (idx === 0 && typeof base === "undefined")
 				return `${a} = typeof ${a} === "object" ? ${a} : {}`;
 			return `${a} = ${a} || {}`;
 		})
-		.join(joinWith || "; ");
+		.join(joinWith);
 };
 
 class LibraryTemplatePlugin {
+	/**
+	 * @param {string} name name of library
+	 * @param {string} target type of library
+	 * @param {boolean} umdNamedDefine setting this to true will name the UMD module
+	 * @param {string|TODO} auxiliaryComment comment in the UMD wrapper
+	 * @param {string|string[]} exportProperty which export should be exposed as library
+	 */
 	constructor(name, target, umdNamedDefine, auxiliaryComment, exportProperty) {
 		this.name = name;
 		this.target = target;
@@ -38,10 +53,14 @@ class LibraryTemplatePlugin {
 		this.exportProperty = exportProperty;
 	}
 
+	/**
+	 * @param {Compiler} compiler the compiler instance
+	 * @returns {void}
+	 */
 	apply(compiler) {
 		compiler.hooks.thisCompilation.tap("LibraryTemplatePlugin", compilation => {
 			if (this.exportProperty) {
-				var ExportPropertyMainTemplatePlugin = require("./ExportPropertyMainTemplatePlugin");
+				const ExportPropertyMainTemplatePlugin = require("./ExportPropertyMainTemplatePlugin");
 				new ExportPropertyMainTemplatePlugin(this.exportProperty).apply(
 					compilation
 				);
@@ -49,66 +68,80 @@ class LibraryTemplatePlugin {
 			switch (this.target) {
 				case "var":
 					new SetVarMainTemplatePlugin(
-						`var ${accessorAccess(false, this.name)}`
+						`var ${accessorAccess(undefined, this.name)}`,
+						false
 					).apply(compilation);
 					break;
 				case "assign":
 					new SetVarMainTemplatePlugin(
-						accessorAccess(undefined, this.name)
+						accessorAccess(undefined, this.name),
+						false
 					).apply(compilation);
 					break;
 				case "this":
 				case "self":
 				case "window":
-					if (this.name)
+					if (this.name) {
 						new SetVarMainTemplatePlugin(
-							accessorAccess(this.target, this.name)
+							accessorAccess(this.target, this.name),
+							false
 						).apply(compilation);
-					else
+					} else {
 						new SetVarMainTemplatePlugin(this.target, true).apply(compilation);
+					}
 					break;
 				case "global":
-					if (this.name)
+					if (this.name) {
 						new SetVarMainTemplatePlugin(
 							accessorAccess(
 								compilation.runtimeTemplate.outputOptions.globalObject,
 								this.name
-							)
+							),
+							false
 						).apply(compilation);
-					else
+					} else {
 						new SetVarMainTemplatePlugin(
 							compilation.runtimeTemplate.outputOptions.globalObject,
 							true
 						).apply(compilation);
+					}
 					break;
 				case "commonjs":
-					if (this.name)
+					if (this.name) {
 						new SetVarMainTemplatePlugin(
-							accessorAccess("exports", this.name)
+							accessorAccess("exports", this.name),
+							false
 						).apply(compilation);
-					else new SetVarMainTemplatePlugin("exports", true).apply(compilation);
+					} else {
+						new SetVarMainTemplatePlugin("exports", true).apply(compilation);
+					}
 					break;
 				case "commonjs2":
 				case "commonjs-module":
-					new SetVarMainTemplatePlugin("module.exports").apply(compilation);
+					new SetVarMainTemplatePlugin("module.exports", false).apply(
+						compilation
+					);
 					break;
-				case "amd":
-					var AmdMainTemplatePlugin = require("./AmdMainTemplatePlugin");
+				case "amd": {
+					const AmdMainTemplatePlugin = require("./AmdMainTemplatePlugin");
 					new AmdMainTemplatePlugin(this.name).apply(compilation);
 					break;
+				}
 				case "umd":
-				case "umd2":
-					var UmdMainTemplatePlugin = require("./UmdMainTemplatePlugin");
+				case "umd2": {
+					const UmdMainTemplatePlugin = require("./UmdMainTemplatePlugin");
 					new UmdMainTemplatePlugin(this.name, {
 						optionalAmdExternalAsGlobal: this.target === "umd2",
 						namedDefine: this.umdNamedDefine,
 						auxiliaryComment: this.auxiliaryComment
 					}).apply(compilation);
 					break;
-				case "jsonp":
-					var JsonpExportMainTemplatePlugin = require("./web/JsonpExportMainTemplatePlugin");
+				}
+				case "jsonp": {
+					const JsonpExportMainTemplatePlugin = require("./web/JsonpExportMainTemplatePlugin");
 					new JsonpExportMainTemplatePlugin(this.name).apply(compilation);
 					break;
+				}
 				default:
 					throw new Error(`${this.target} is not a valid Library target`);
 			}

package/lib/ModuleDependencyError.js

@@ -7,7 +7,15 @@
 const WebpackError = require("./WebpackError");
 const formatLocation = require("./formatLocation");
 
-module.exports = class ModuleDependencyError extends WebpackError {
+/** @typedef {import("./Module")} Module */
+
+class ModuleDependencyError extends WebpackError {
+	/**
+	 * Creates an instance of ModuleDependencyError.
+	 * @param {Module} module module tied to dependency
+	 * @param {Error} err error thrown
+	 * @param {TODO} loc location of dependency
+	 */
 	constructor(module, err, loc) {
 		super();
 
@@ -22,4 +30,6 @@ module.exports = class ModuleDependencyError extends WebpackError {
 
 		Error.captureStackTrace(this, this.constructor);
 	}
-};
+}
+
+module.exports = ModuleDependencyError;

package/lib/ProgressPlugin.js

@@ -83,7 +83,7 @@ class ProgressPlugin {
 			const states = new Array(compiler.compilers.length);
 			compiler.compilers.forEach((compiler, idx) => {
 				new ProgressPlugin((p, msg, ...args) => {
-					states[idx] = args;
+					states[idx] = [p, msg, ...args];
 					handler(
 						states
 							.map(state => (state && state[0]) || 0)

package/lib/SetVarMainTemplatePlugin.js

@@ -6,12 +6,24 @@
 
 const { ConcatSource } = require("webpack-sources");
 
+/** @typedef {import("./Compilation")} Compilation */
+
 class SetVarMainTemplatePlugin {
+	/**
+	 * @param {string} varExpression the accessor where the library is exported
+	 * @param {boolean} copyObject specify copying the exports
+	 */
 	constructor(varExpression, copyObject) {
+		/** @type {string} */
 		this.varExpression = varExpression;
+		/** @type {boolean} */
 		this.copyObject = copyObject;
 	}
 
+	/**
+	 * @param {Compilation} compilation the compilation instance
+	 * @returns {void}
+	 */
 	apply(compilation) {
 		const { mainTemplate, chunkTemplate } = compilation;
 

package/lib/UmdMainTemplatePlugin.js

@@ -7,22 +7,59 @@
 const { ConcatSource, OriginalSource } = require("webpack-sources");
 const Template = require("./Template");
 
-function accessorToObjectAccess(accessor) {
+/** @typedef {import("./Compilation")} Compilation */
+
+/**
+ * @param {string[]} accessor the accessor to convert to path
+ * @returns {string} the path
+ */
+const accessorToObjectAccess = accessor => {
 	return accessor.map(a => `[${JSON.stringify(a)}]`).join("");
-}
+};
 
-function accessorAccess(base, accessor) {
-	accessor = [].concat(accessor);
-	return accessor
-		.map((a, idx) => {
-			a = base + accessorToObjectAccess(accessor.slice(0, idx + 1));
-			if (idx === accessor.length - 1) return a;
+/**
+ * @param {string=} base the path prefix
+ * @param {string|string[]} accessor the accessor
+ * @param {string=} joinWith the element separator
+ * @returns {string} the path
+ */
+const accessorAccess = (base, accessor, joinWith = ", ") => {
+	const accessors = Array.isArray(accessor) ? accessor : [accessor];
+	return accessors
+		.map((_, idx) => {
+			const a = base
+				? base + accessorToObjectAccess(accessors.slice(0, idx + 1))
+				: accessors[0] + accessorToObjectAccess(accessors.slice(1, idx + 1));
+			if (idx === accessors.length - 1) return a;
+			if (idx === 0 && typeof base === "undefined")
+				return `${a} = typeof ${a} === "object" ? ${a} : {}`;
 			return `${a} = ${a} || {}`;
 		})
-		.join(", ");
-}
+		.join(joinWith);
+};
+
+/** @typedef {string | string[] | Record<string, string | string[]>} UmdMainTemplatePluginName */
+
+/**
+ * @typedef {Object} AuxiliaryCommentObject
+ * @property {string} root
+ * @property {string} commonjs
+ * @property {string} commonjs2
+ * @property {string} amd
+ */
+
+/**
+ * @typedef {Object} UmdMainTemplatePluginOption
+ * @property {boolean=} optionalAmdExternalAsGlobal
+ * @property {boolean} namedDefine
+ * @property {string | AuxiliaryCommentObject} auxiliaryComment
+ */
 
 class UmdMainTemplatePlugin {
+	/**
+	 * @param {UmdMainTemplatePluginName} name the name of the UMD library
+	 * @param {UmdMainTemplatePluginOption} options the plugin option
+	 */
 	constructor(name, options) {
 		if (typeof name === "object" && !Array.isArray(name)) {
 			this.name = name.root || name.amd || name.commonjs;
@@ -40,6 +77,10 @@ class UmdMainTemplatePlugin {
 		this.auxiliaryComment = options.auxiliaryComment;
 	}
 
+	/**
+	 * @param {Compilation} compilation the compilation instance
+	 * @returns {void}
+	 */
 	apply(compilation) {
 		const { mainTemplate, chunkTemplate, runtimeTemplate } = compilation;
 
@@ -152,23 +193,27 @@ class UmdMainTemplatePlugin {
 				amdFactory = "factory";
 			}
 
+			const auxiliaryComment = this.auxiliaryComment;
+
+			const getAuxilaryComment = type => {
+				if (auxiliaryComment) {
+					if (typeof auxiliaryComment === "string")
+						return "\t//" + auxiliaryComment + "\n";
+					if (auxiliaryComment[type])
+						return "\t//" + auxiliaryComment[type] + "\n";
+				}
+				return "";
+			};
+
 			return new ConcatSource(
 				new OriginalSource(
 					"(function webpackUniversalModuleDefinition(root, factory) {\n" +
-						(this.auxiliaryComment && typeof this.auxiliaryComment === "string"
-							? "	//" + this.auxiliaryComment + "\n"
-							: this.auxiliaryComment.commonjs2
-								? "	//" + this.auxiliaryComment.commonjs2 + "\n"
-								: "") +
+						getAuxilaryComment("commonjs2") +
 						"	if(typeof exports === 'object' && typeof module === 'object')\n" +
 						"		module.exports = factory(" +
 						externalsRequireArray("commonjs2") +
 						");\n" +
-						(this.auxiliaryComment && typeof this.auxiliaryComment === "string"
-							? "	//" + this.auxiliaryComment + "\n"
-							: this.auxiliaryComment.amd
-								? "	//" + this.auxiliaryComment.amd + "\n"
-								: "") +
+						getAuxilaryComment("amd") +
 						"	else if(typeof define === 'function' && define.amd)\n" +
 						(requiredExternals.length > 0
 							? this.names.amd && this.namedDefine === true
@@ -192,24 +237,14 @@ class UmdMainTemplatePlugin {
 								  ");\n"
 								: "		define([], " + amdFactory + ");\n") +
 						(this.names.root || this.names.commonjs
-							? (this.auxiliaryComment &&
-							  typeof this.auxiliaryComment === "string"
-									? "	//" + this.auxiliaryComment + "\n"
-									: this.auxiliaryComment.commonjs
-										? "	//" + this.auxiliaryComment.commonjs + "\n"
-										: "") +
+							? getAuxilaryComment("commonjs") +
 							  "	else if(typeof exports === 'object')\n" +
 							  "		exports[" +
 							  libraryName(this.names.commonjs || this.names.root) +
 							  "] = factory(" +
 							  externalsRequireArray("commonjs") +
 							  ");\n" +
-							  (this.auxiliaryComment &&
-							  typeof this.auxiliaryComment === "string"
-									? "	//" + this.auxiliaryComment + "\n"
-									: this.auxiliaryComment.root
-										? "	//" + this.auxiliaryComment.root + "\n"
-										: "") +
+							  getAuxilaryComment("root") +
 							  "	else\n" +
 							  "		" +
 							  replaceKeys(

package/lib/WebpackError.js

@@ -4,7 +4,11 @@
 */
 "use strict";
 
-module.exports = class WebpackError extends Error {
+class WebpackError extends Error {
+	/**
+	 * Creates an instance of WebpackError.
+	 * @param {string=} message error message
+	 */
 	constructor(message) {
 		super(message);
 
@@ -16,4 +20,6 @@ module.exports = class WebpackError extends Error {
 	inspect() {
 		return this.stack + (this.details ? `\n${this.details}` : "");
 	}
-};
+}
+
+module.exports = WebpackError;

package/lib/web/JsonpMainTemplatePlugin.js

@@ -173,7 +173,6 @@ class JsonpMainTemplatePlugin {
 						"onScriptComplete({ type: 'timeout', target: script });"
 					]),
 					`}, ${chunkLoadTimeout});`,
-					"script.onerror = script.onload = onScriptComplete;",
 					"function onScriptComplete(event) {",
 					Template.indent([
 						"// avoid mem leaks in IE.",
@@ -196,7 +195,8 @@ class JsonpMainTemplatePlugin {
 						]),
 						"}"
 					]),
-					"};"
+					"};",
+					"script.onerror = script.onload = onScriptComplete;"
 				]);
 			}
 		);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack",
-  "version": "4.9.1",
+  "version": "4.9.2",
   "author": "Tobias Koppers @sokra",
   "description": "Packs CommonJs/AMD modules for the browser. Allows to split your codebase into multiple bundles, which can be loaded on demand. Support loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.",
   "license": "MIT",