webpack 4.19.0 → 4.20.2

package/lib/Module.js

@@ -262,6 +262,10 @@ class Module extends DependenciesBlock {
 		}
 	}
 
+	/**
+	 * @param {string=} exportName the name of the export
+	 * @returns {boolean|string} false if the export isn't used, true if no exportName is provided and the module is used, or the name to access it if the export is used
+	 */
 	isUsed(exportName) {
 		if (!exportName) return this.used !== false;
 		if (this.used === null || this.usedExports === null) return exportName;

package/lib/SourceMapDevToolPlugin.js

@@ -13,6 +13,8 @@ const createHash = require("./util/createHash");
 const validateOptions = require("schema-utils");
 const schema = require("../schemas/plugins/SourceMapDevToolPlugin.json");
 
+/** @typedef {import("../declarations/plugins/SourceMapDevToolPlugin").SourceMapDevToolPluginOptions} SourceMapDevToolPluginOptions */
+
 const basename = name => {
 	if (!name.includes("/")) return name;
 	return name.substr(name.lastIndexOf("/") + 1);
@@ -52,6 +54,9 @@ const getTaskForFile = (file, chunk, options, compilation) => {
 };
 
 class SourceMapDevToolPlugin {
+	/**
+	 * @param {SourceMapDevToolPluginOptions=} options options object
+	 */
 	constructor(options) {
 		if (arguments.length > 1) {
 			throw new Error(
@@ -59,10 +64,12 @@ class SourceMapDevToolPlugin {
 			);
 		}
 
-		validateOptions(schema, options || {}, "SourceMap DevTool Plugin");
-
 		if (!options) options = {};
+
+		validateOptions(schema, options, "SourceMap DevTool Plugin");
+
 		this.sourceMapFilename = options.filename;
+		/** @type {string | false} */
 		this.sourceMappingURLComment =
 			options.append === false
 				? false
@@ -84,7 +91,7 @@ class SourceMapDevToolPlugin {
 		const fallbackModuleFilenameTemplate = this.fallbackModuleFilenameTemplate;
 		const requestShortener = compiler.requestShortener;
 		const options = this.options;
-		options.test = options.test || /\.(js|css)($|\?)/i;
+		options.test = options.test || /\.(m?js|css)($|\?)/i;
 
 		const matchObject = ModuleFilenameHelpers.matchObject.bind(
 			undefined,
@@ -227,6 +234,7 @@ class SourceMapDevToolPlugin {
 						sourceMap.sourceRoot = options.sourceRoot || "";
 						sourceMap.file = file;
 						assetsCache.set(asset, { file, assets });
+						/** @type {string | false} */
 						let currentSourceMappingURLComment = sourceMappingURLComment;
 						if (
 							currentSourceMappingURLComment !== false &&
@@ -276,6 +284,11 @@ class SourceMapDevToolPlugin {
 							] = new RawSource(sourceMapString);
 							chunk.files.push(sourceMapFile);
 						} else {
+							if (currentSourceMappingURLComment === false) {
+								throw new Error(
+									"SourceMapDevToolPlugin: append can't be false when no filename is provided"
+								);
+							}
 							assets[file] = compilation.assets[file] = new ConcatSource(
 								new RawSource(source),
 								currentSourceMappingURLComment

package/lib/Template.js

@@ -252,6 +252,7 @@ class Template {
 				source.add(`Array(${minId}).concat(`);
 			}
 			source.add("[\n");
+			/** @type {Map<string|number, {id: string|number, source: Source|string}>} */
 			const modules = new Map();
 			for (const module of allModules) {
 				modules.set(module.id, module);

package/lib/UmdMainTemplatePlugin.js

@@ -7,6 +7,7 @@
 const { ConcatSource, OriginalSource } = require("webpack-sources");
 const Template = require("./Template");
 
+/** @typedef {import("../declarations/WebpackOptions").LibraryCustomUmdObject} LibraryCustomUmdObject */
 /** @typedef {import("./Compilation")} Compilation */
 
 /**
@@ -38,7 +39,7 @@ const accessorAccess = (base, accessor, joinWith = ", ") => {
 		.join(joinWith);
 };
 
-/** @typedef {string | string[] | Record<string, string | string[]>} UmdMainTemplatePluginName */
+/** @typedef {string | string[] | LibraryCustomUmdObject} UmdMainTemplatePluginName */
 
 /**
  * @typedef {Object} AuxiliaryCommentObject

package/lib/WatchIgnorePlugin.js

@@ -7,6 +7,8 @@
 const validateOptions = require("schema-utils");
 const schema = require("../schemas/plugins/WatchIgnorePlugin.json");
 
+/** @typedef {import("../declarations/plugins/WatchIgnorePlugin").WatchIgnorePluginOptions} WatchIgnorePluginOptions */
+
 class IgnoringWatchFileSystem {
 	constructor(wfs, paths) {
 		this.wfs = wfs;
@@ -82,6 +84,9 @@ class IgnoringWatchFileSystem {
 }
 
 class WatchIgnorePlugin {
+	/**
+	 * @param {WatchIgnorePluginOptions} paths list of paths
+	 */
 	constructor(paths) {
 		validateOptions(schema, paths, "Watch Ignore Plugin");
 		this.paths = paths;

package/lib/WebpackOptionsApply.js

@@ -63,11 +63,19 @@ const DefinePlugin = require("./DefinePlugin");
 const SizeLimitsPlugin = require("./performance/SizeLimitsPlugin");
 const WasmFinalizeExportsPlugin = require("./wasm/WasmFinalizeExportsPlugin");
 
+/** @typedef {import("../declarations/WebpackOptions").WebpackOptions} WebpackOptions */
+/** @typedef {import("./Compiler")} Compiler */
+
 class WebpackOptionsApply extends OptionsApply {
 	constructor() {
 		super();
 	}
 
+	/**
+	 * @param {WebpackOptions} options options object
+	 * @param {Compiler} compiler compiler object
+	 * @returns {WebpackOptions} options object
+	 */
 	process(options, compiler) {
 		let ExternalsPlugin;
 		compiler.outputPath = options.output.path;
@@ -75,6 +83,8 @@ class WebpackOptionsApply extends OptionsApply {
 		compiler.recordsOutputPath =
 			options.recordsOutputPath || options.recordsPath;
 		compiler.name = options.name;
+		// TODO webpack 5 refactor this to MultiCompiler.setDependencies() with a WeakMap
+		// @ts-ignore TODO
 		compiler.dependencies = options.dependencies;
 		if (typeof options.target === "string") {
 			let JsonpTemplatePlugin;
@@ -201,7 +211,9 @@ class WebpackOptionsApply extends OptionsApply {
 				default:
 					throw new Error("Unsupported target '" + options.target + "'.");
 			}
-		} else if (options.target !== false) {
+		}
+		// @ts-ignore This is always true, which is good this way
+		else if (options.target !== false) {
 			options.target(compiler);
 		} else {
 			throw new Error("Unsupported target '" + options.target + "'.");
@@ -450,7 +462,11 @@ class WebpackOptionsApply extends OptionsApply {
 		}
 		if (options.optimization.minimize) {
 			for (const minimizer of options.optimization.minimizer) {
-				minimizer.apply(compiler);
+				if (typeof minimizer === "function") {
+					minimizer.apply(compiler);
+				} else {
+					minimizer.apply(compiler);
+				}
 			}
 		}
 

package/lib/WebpackOptionsDefaulter.js

@@ -327,7 +327,11 @@ class WebpackOptionsDefaulter extends OptionsDefaulter {
 		this.set("resolve.extensions", [".wasm", ".mjs", ".js", ".json"]);
 		this.set("resolve.mainFiles", ["index"]);
 		this.set("resolve.aliasFields", "make", options => {
-			if (options.target === "web" || options.target === "webworker") {
+			if (
+				options.target === "web" ||
+				options.target === "webworker" ||
+				options.target === "electron-renderer"
+			) {
 				return ["browser"];
 			} else {
 				return [];

package/lib/debug/ProfilingPlugin.js

@@ -2,6 +2,9 @@ const fs = require("fs");
 const { Tracer } = require("chrome-trace-event");
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/debug/ProfilingPlugin.json");
+
+/** @typedef {import("../../declarations/plugins/debug/ProfilingPlugin").ProfilingPluginOptions} ProfilingPluginOptions */
+
 let inspector = undefined;
 
 try {
@@ -145,6 +148,9 @@ const createTrace = outputPath => {
 const pluginName = "ProfilingPlugin";
 
 class ProfilingPlugin {
+	/**
+	 * @param {ProfilingPluginOptions=} opts options object
+	 */
 	constructor(opts) {
 		validateOptions(schema, opts || {}, "Profiling plugin");
 		opts = opts || {};

package/lib/dependencies/HarmonyExportDependencyParserPlugin.js

@@ -54,10 +54,25 @@ module.exports = class HarmonyExportDependencyParserPlugin {
 		parser.hooks.exportExpression.tap(
 			"HarmonyExportDependencyParserPlugin",
 			(statement, expr) => {
+				const comments = parser.getComments([
+					statement.range[0],
+					expr.range[0]
+				]);
 				const dep = new HarmonyExportExpressionDependency(
 					parser.state.module,
 					expr.range,
-					statement.range
+					statement.range,
+					comments
+						.map(c => {
+							switch (c.type) {
+								case "Block":
+									return `/*${c.value}*/`;
+								case "Line":
+									return `//${c.value}\n`;
+							}
+							return "";
+						})
+						.join("")
 				);
 				dep.loc = Object.create(statement.loc);
 				dep.loc.index = -1;

package/lib/dependencies/HarmonyExportExpressionDependency.js

@@ -6,11 +6,12 @@
 const NullDependency = require("./NullDependency");
 
 class HarmonyExportExpressionDependency extends NullDependency {
-	constructor(originModule, range, rangeStatement) {
+	constructor(originModule, range, rangeStatement, prefix) {
 		super();
 		this.originModule = originModule;
 		this.range = range;
 		this.rangeStatement = rangeStatement;
+		this.prefix = prefix;
 	}
 
 	get type() {
@@ -31,7 +32,11 @@ HarmonyExportExpressionDependency.Template = class HarmonyExportDependencyTempla
 		const content = this.getContent(dep.originModule, used);
 
 		if (dep.range) {
-			source.replace(dep.rangeStatement[0], dep.range[0] - 1, content + "(");
+			source.replace(
+				dep.rangeStatement[0],
+				dep.range[0] - 1,
+				content + "(" + dep.prefix
+			);
 			source.replace(dep.range[1], dep.rangeStatement[1] - 1, ");");
 			return;
 		}

package/lib/dependencies/ImportParserPlugin.js

@@ -66,7 +66,7 @@ class ImportParserPlugin {
 							)
 						);
 					} else {
-						// Do not instrument `import()` is `webpackIgnore` is `true`
+						// Do not instrument `import()` if `webpackIgnore` is `true`
 						if (importOptions.webpackIgnore) {
 							return false;
 						}

package/lib/dependencies/WebAssemblyImportDependency.js

@@ -8,12 +8,20 @@ const DependencyReference = require("./DependencyReference");
 const ModuleDependency = require("./ModuleDependency");
 const UnsupportedWebAssemblyFeatureError = require("../wasm/UnsupportedWebAssemblyFeatureError");
 
+/** @typedef {import("@webassemblyjs/ast").ModuleImportDescription} ModuleImportDescription */
+
 class WebAssemblyImportDependency extends ModuleDependency {
+	/**
+	 * @param {string} request the request
+	 * @param {string} name the imported name
+	 * @param {ModuleImportDescription} description the WASM ast node
+	 * @param {false | string} onlyDirectImport if only direct imports are allowed
+	 */
 	constructor(request, name, description, onlyDirectImport) {
 		super(request);
 		/** @type {string} */
 		this.name = name;
-		/** @type {TODO} */
+		/** @type {ModuleImportDescription} */
 		this.description = description;
 		/** @type {false | string} */
 		this.onlyDirectImport = onlyDirectImport;

package/lib/node/NodeMainTemplatePlugin.js

@@ -96,7 +96,7 @@ module.exports = class NodeMainTemplatePlugin {
 								"var promise = new Promise(function(resolve, reject) {",
 								Template.indent([
 									"installedChunkData = installedChunks[chunkId] = [resolve, reject];",
-									"var filename = __dirname + " +
+									"var filename = require('path').join(__dirname, " +
 										mainTemplate.getAssetPath(
 											JSON.stringify(`/${chunkFilename}`),
 											{
@@ -155,7 +155,7 @@ module.exports = class NodeMainTemplatePlugin {
 												contentHashType: "javascript"
 											}
 										) +
-										";",
+										");",
 									"require('fs').readFile(filename, 'utf-8',  function(err, content) {",
 									Template.indent(
 										[

package/lib/optimize/AggressiveSplittingPlugin.js

@@ -9,6 +9,8 @@ const { intersect } = require("../util/SetHelpers");
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/optimize/AggressiveSplittingPlugin.json");
 
+/** @typedef {import("../../declarations/plugins/optimize/AggressiveSplittingPlugin").AggressiveSplittingPluginOptions} AggressiveSplittingPluginOptions */
+
 const moveModuleBetween = (oldChunk, newChunk) => {
 	return module => {
 		oldChunk.moveModule(module, newChunk);
@@ -22,10 +24,15 @@ const isNotAEntryModule = entryModule => {
 };
 
 class AggressiveSplittingPlugin {
+	/**
+	 * @param {AggressiveSplittingPluginOptions=} options options object
+	 */
 	constructor(options) {
-		validateOptions(schema, options || {}, "Aggressive Splitting Plugin");
+		if (!options) options = {};
+
+		validateOptions(schema, options, "Aggressive Splitting Plugin");
 
-		this.options = options || {};
+		this.options = options;
 		if (typeof this.options.minSize !== "number") {
 			this.options.minSize = 30 * 1024;
 		}

package/lib/optimize/ConcatenatedModule.js

@@ -1364,12 +1364,20 @@ class HarmonyExportExpressionDependencyConcatenatedTemplate {
 		}
 
 		if (dep.range) {
-			source.replace(dep.rangeStatement[0], dep.range[0] - 1, content + "(");
+			source.replace(
+				dep.rangeStatement[0],
+				dep.range[0] - 1,
+				content + "(" + dep.prefix
+			);
 			source.replace(dep.range[1], dep.rangeStatement[1] - 1, ");");
 			return;
 		}
 
-		source.replace(dep.rangeStatement[0], dep.rangeStatement[1] - 1, content);
+		source.replace(
+			dep.rangeStatement[0],
+			dep.rangeStatement[1] - 1,
+			content + dep.prefix
+		);
 	}
 }
 

package/lib/optimize/LimitChunkCountPlugin.js

@@ -7,10 +7,17 @@
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/optimize/LimitChunkCountPlugin.json");
 
+/** @typedef {import("../../declarations/plugins/optimize/LimitChunkCountPlugin").LimitChunkCountPluginOptions} LimitChunkCountPluginOptions */
+
 class LimitChunkCountPlugin {
+	/**
+	 * @param {LimitChunkCountPluginOptions=} options options object
+	 */
 	constructor(options) {
-		validateOptions(schema, options || {}, "Limit Chunk Count Plugin");
-		this.options = options || {};
+		if (!options) options = {};
+
+		validateOptions(schema, options, "Limit Chunk Count Plugin");
+		this.options = options;
 	}
 	apply(compiler) {
 		const options = this.options;

package/lib/optimize/MinChunkSizePlugin.js

@@ -7,7 +7,12 @@
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/optimize/MinChunkSizePlugin.json");
 
+/** @typedef {import("../../declarations/plugins/optimize/MinChunkSizePlugin").MinChunkSizePluginOptions} MinChunkSizePluginOptions */
+
 class MinChunkSizePlugin {
+	/**
+	 * @param {MinChunkSizePluginOptions} options options object
+	 */
 	constructor(options) {
 		validateOptions(schema, options, "Min Chunk Size Plugin");
 		this.options = options;

package/lib/optimize/OccurrenceChunkOrderPlugin.js

@@ -7,7 +7,12 @@
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/optimize/OccurrenceOrderChunkIdsPlugin.json");
 
+/** @typedef {import("../../declarations/plugins/optimize/OccurrenceOrderChunkIdsPlugin").OccurrenceOrderChunkIdsPluginOptions} OccurrenceOrderChunkIdsPluginOptions */
+
 class OccurrenceOrderChunkIdsPlugin {
+	/**
+	 * @param {OccurrenceOrderChunkIdsPluginOptions=} options options object
+	 */
 	constructor(options = {}) {
 		validateOptions(schema, options, "Occurrence Order Chunk Ids Plugin");
 		this.options = options;

package/lib/optimize/OccurrenceModuleOrderPlugin.js

@@ -7,7 +7,12 @@
 const validateOptions = require("schema-utils");
 const schema = require("../../schemas/plugins/optimize/OccurrenceOrderModuleIdsPlugin.json");
 
+/** @typedef {import("../../declarations/plugins/optimize/OccurrenceOrderModuleIdsPlugin").OccurrenceOrderModuleIdsPluginOptions} OccurrenceOrderModuleIdsPluginOptions */
+
 class OccurrenceOrderModuleIdsPlugin {
+	/**
+	 * @param {OccurrenceOrderModuleIdsPluginOptions=} options options object
+	 */
 	constructor(options = {}) {
 		validateOptions(schema, options, "Occurrence Order Module Ids Plugin");
 		this.options = options;

package/lib/web/JsonpExportMainTemplatePlugin.js

@@ -7,6 +7,9 @@
 const { ConcatSource } = require("webpack-sources");
 
 class JsonpExportMainTemplatePlugin {
+	/**
+	 * @param {string} name jsonp function name
+	 */
 	constructor(name) {
 		this.name = name;
 	}

package/lib/webpack.js

@@ -15,6 +15,13 @@ const webpackOptionsSchema = require("../schemas/WebpackOptions.json");
 const RemovedPluginError = require("./RemovedPluginError");
 const version = require("../package.json").version;
 
+/** @typedef {import("../declarations/WebpackOptions").WebpackOptions} WebpackOptions */
+
+/**
+ * @param {WebpackOptions} options options object
+ * @param {function(Error=, Stats=): void=} callback callback
+ * @returns {Compiler | MultiCompiler} the compiler object
+ */
 const webpack = (options, callback) => {
 	const webpackOptionsValidationErrors = validateSchema(
 		webpackOptionsSchema,
@@ -34,7 +41,11 @@ const webpack = (options, callback) => {
 		new NodeEnvironmentPlugin().apply(compiler);
 		if (options.plugins && Array.isArray(options.plugins)) {
 			for (const plugin of options.plugins) {
-				plugin.apply(compiler);
+				if (typeof plugin === "function") {
+					plugin.apply(compiler);
+				} else {
+					plugin.apply(compiler);
+				}
 			}
 		}
 		compiler.hooks.environment.call();

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "webpack",
-  "version": "4.19.0",
+  "version": "4.20.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",
   "dependencies": {
-    "@webassemblyjs/ast": "1.7.6",
-    "@webassemblyjs/helper-module-context": "1.7.6",
-    "@webassemblyjs/wasm-edit": "1.7.6",
-    "@webassemblyjs/wasm-parser": "1.7.6",
+    "@webassemblyjs/ast": "1.7.8",
+    "@webassemblyjs/helper-module-context": "1.7.8",
+    "@webassemblyjs/wasm-edit": "1.7.8",
+    "@webassemblyjs/wasm-parser": "1.7.8",
     "acorn": "^5.6.2",
     "acorn-dynamic-import": "^3.0.0",
     "ajv": "^6.1.0",
@@ -28,7 +28,7 @@
     "tapable": "^1.1.0",
     "uglifyjs-webpack-plugin": "^1.2.4",
     "watchpack": "^1.5.0",
-    "webpack-sources": "^1.2.0"
+    "webpack-sources": "^1.3.0"
   },
   "devDependencies": {
     "@types/node": "^9.6.4",
@@ -58,6 +58,7 @@
     "jest": "^23.4.1",
     "jest-silent-reporter": "^0.0.5",
     "json-loader": "^0.5.7",
+    "json-schema-to-typescript": "^6.0.1",
     "less": "^2.5.1",
     "less-loader": "^4.0.3",
     "lint-staged": "^7.2.0",
@@ -118,10 +119,12 @@
     "build:examples": "cd examples && node buildAll.js",
     "pretest": "yarn lint",
     "prelint": "yarn setup",
-    "lint": "yarn code-lint && yarn schema-lint && yarn type-lint",
+    "lint": "yarn code-lint && yarn schema-lint && yarn type-lint && yarn special-lint",
     "code-lint": "eslint --cache \"{setup,lib,bin,hot,buildin,benchmark,tooling,schemas}/**/*.js\" \"test/*.js\" \"test/{configCases,watchCases,statsCases,hotCases}/**/webpack.config.js\" \"examples/**/webpack.config.js\"",
     "type-lint": "tsc --pretty",
-    "fix": "yarn code-lint --fix",
+    "special-lint": "node tooling/inherit-types && node tooling/format-schemas && node tooling/compile-to-definitions",
+    "special-lint-fix": "node tooling/inherit-types --write --override && node tooling/format-schemas --write && node tooling/compile-to-definitions --write",
+    "fix": "yarn code-lint --fix && yarn special-lint-fix",
     "pretty": "prettier --loglevel warn --write \"*.{ts,js,json}\" \"{setup,lib,bin,hot,buildin,benchmark,tooling,schemas}/**/*.{js,json}\" \"test/*.js\" \"test/{configCases,watchCases,statsCases,hotCases}/**/webpack.config.js\" \"examples/**/webpack.config.js\"",
     "schema-lint": "node --max-old-space-size=4096 node_modules/jest-cli/bin/jest --testMatch \"<rootDir>/test/*.lint.js\" --no-verbose",
     "benchmark": "node --max-old-space-size=4096 --trace-deprecation node_modules/jest-cli/bin/jest --testMatch \"<rootDir>/test/*.benchmark.js\" --runInBand",