webpack 4.8.2 → 4.9.2

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/compareLocations.js

@@ -3,6 +3,26 @@
 	Author Tobias Koppers @sokra
 */
 "use strict";
+
+/**
+ * @typedef {Object} LineAndColumn
+ * @property {number=} line
+ * @property {number=} column
+ */
+
+/**
+ * @typedef {Object} NodeLocation
+ * @property {LineAndColumn=} start
+ * @property {LineAndColumn=} end
+ * @property {number=} index
+ */
+
+/**
+ * Compare two locations
+ * @param {string|NodeLocation} a A location node
+ * @param {string|NodeLocation} b A location node
+ * @returns {-1|0|1} sorting comparator value
+ */
 module.exports = (a, b) => {
 	if (typeof a === "string") {
 		if (typeof b === "string") {