Merge branch 'master' of https://github.com/webpack/webpack into jest

niieani · niieani · commit ddc9988c10d2 · 2018-04-26T23:44:02.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,17 +11,23 @@ Most of the time, if webpack is not working correctly for you it is a simple con
 
 If you are still having difficulty after looking over your configuration carefully, please post
 a question to [StackOverflow with the webpack tag](http://stackoverflow.com/tags/webpack). Questions
-that include your webpack.config.js and relevant files are more likely to receive responses.
+that include your webpack.config.js, relevant files, and the full error message are more likely to receive responses.
 
 **If you have discovered a bug or have a feature suggestion, please [create an issue on GitHub](https://github.com/webpack/webpack/issues/new).**
 
+Do you want to fix an issue?  Look at the issues with a tag of [X5: work required (PR / Help Wanted)](https://github.com/webpack/webpack/labels/X5%3A%20work%20required%20%28PR%20%2F%20Help%20Wanted%29).  Each issue should be tagged with a difficulty tag -
+
+- D0: My First Commit (Contribution Difficulty)
+- D1: Easy (Contribution Difficulty)
+- D2: Medium (Contribution Difficulty)
+- D3: Hard (Contribution Difficulty)
+
 ## Contributing to the webpack ecosystem
 
-If you have created your own loader/plugin please include it on the relevant
-documentation pages:
+If you have created your own loader/plugin please include it on the relevant documentation pages:
 
-[List of loaders](https://webpack.js.org/loaders/) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#loaders)
-[List of plugins](https://webpack.js.org/plugins) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#webpack-plugins)
+- [List of loaders](https://webpack.js.org/loaders/) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#loaders)
+- [List of plugins](https://webpack.js.org/plugins) or [awesome-webpack](https://github.com/webpack-contrib/awesome-webpack#webpack-plugins)
 
 ## Setup
 
@@ -43,7 +49,7 @@ Some things that will increase the chance that your pull request is accepted:
 
 webpack is insanely feature rich and documentation is a huge time sink. We
 greatly appreciate any time spent fixing typos or clarifying sections in the
-documentation.
+documentation. [See a list of issues with the documentation tag.](https://github.com/webpack/webpack/labels/documentation)
 
 ## Discussions
 
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,9 @@
+# Reporting Security Issues
+
+If you discover a security issue in webpack, please report it by sending an
+email to [webpack@opencollective.com](mailto:webpack@opencollective.com).
+
+This will allow us to assess the risk, and make a fix available before we add a
+bug report to the GitHub repository.
+
+Thanks for helping make webpack safe for everyone.
diff --git a/_SETUP.md b/_SETUP.md
@@ -16,7 +16,7 @@ Setup your local webpack repository
 git clone https://github.com/webpack/webpack.git
 cd webpack
 npm install -g yarn
-yarn install
+yarn
 yarn link
 yarn link webpack
 ```
diff --git a/lib/Stats.js b/lib/Stats.js
@@ -135,6 +135,10 @@ class Stats {
 		const showBuiltAt = optionOrLocalFallback(options.builtAt, true);
 		const showAssets = optionOrLocalFallback(options.assets, true);
 		const showEntrypoints = optionOrLocalFallback(options.entrypoints, true);
+		const showChunkGroups = optionOrLocalFallback(
+			options.chunkGroups,
+			!forToString
+		);
 		const showChunks = optionOrLocalFallback(options.chunks, !forToString);
 		const showChunkModules = optionOrLocalFallback(options.chunkModules, true);
 		const showChunkOrigins = optionOrLocalFallback(
@@ -396,15 +400,15 @@ class Stats {
 			obj.assets.sort(sortByField(sortAssets));
 		}
 
-		if (showEntrypoints) {
-			obj.entrypoints = {};
-			for (const keyValuePair of compilation.entrypoints) {
+		const fnChunkGroup = groupMap => {
+			const obj = {};
+			for (const keyValuePair of groupMap) {
 				const name = keyValuePair[0];
-				const ep = keyValuePair[1];
-				const children = ep.getChildrenByOrders();
-				obj.entrypoints[name] = {
-					chunks: ep.chunks.map(c => c.id),
-					assets: ep.chunks.reduce(
+				const cg = keyValuePair[1];
+				const children = cg.getChildrenByOrders();
+				obj[name] = {
+					chunks: cg.chunks.map(c => c.id),
+					assets: cg.chunks.reduce(
 						(array, c) => array.concat(c.files || []),
 						[]
 					),
@@ -436,9 +440,19 @@ class Stats {
 					}, Object.create(null))
 				};
 				if (showPerformance) {
-					obj.entrypoints[name].isOverSizeLimit = ep.isOverSizeLimit;
+					obj[name].isOverSizeLimit = cg.isOverSizeLimit;
 				}
 			}
+
+			return obj;
+		};
+
+		if (showEntrypoints) {
+			obj.entrypoints = fnChunkGroup(compilation.entrypoints);
+		}
+
+		if (showChunkGroups) {
+			obj.namedChunkGroups = fnChunkGroup(compilation.namedChunkGroups);
 		}
 
 		const fnModule = module => {
@@ -866,22 +880,23 @@ class Stats {
 			colors.normal(obj.filteredAssets !== 1 ? " assets" : " asset");
 			newline();
 		}
-		if (obj.entrypoints) {
-			for (const name of Object.keys(obj.entrypoints)) {
-				const ep = obj.entrypoints[name];
-				colors.normal("Entrypoint ");
+
+		const processChunkGroups = (namedGroups, prefix) => {
+			for (const name of Object.keys(namedGroups)) {
+				const cg = namedGroups[name];
+				colors.normal(`${prefix} `);
 				colors.bold(name);
-				if (ep.isOverSizeLimit) {
+				if (cg.isOverSizeLimit) {
 					colors.normal(" ");
 					colors.yellow("[big]");
 				}
 				colors.normal(" =");
-				for (const asset of ep.assets) {
+				for (const asset of cg.assets) {
 					colors.normal(" ");
 					colors.green(asset);
 				}
-				for (const name of Object.keys(ep.childAssets)) {
-					const assets = ep.childAssets[name];
+				for (const name of Object.keys(cg.childAssets)) {
+					const assets = cg.childAssets[name];
 					if (assets && assets.length > 0) {
 						colors.normal(" ");
 						colors.magenta(`(${name}:`);
@@ -894,7 +909,25 @@ class Stats {
 				}
 				newline();
 			}
+		};
+
+		if (obj.entrypoints) {
+			processChunkGroups(obj.entrypoints, "Entrypoint");
 		}
+
+		if (obj.namedChunkGroups) {
+			let outputChunkGroups = obj.namedChunkGroups;
+			if (obj.entrypoints) {
+				outputChunkGroups = Object.keys(outputChunkGroups)
+					.filter(name => !obj.entrypoints[name])
+					.reduce((result, name) => {
+						result[name] = obj.namedChunkGroups[name];
+						return result;
+					}, {});
+			}
+			processChunkGroups(outputChunkGroups, "Chunk Group");
+		}
+
 		const modulesByIdentifier = {};
 		if (obj.modules) {
 			for (const module of obj.modules) {
@@ -1260,6 +1293,7 @@ class Stats {
 			case "verbose":
 				return {
 					entrypoints: true,
+					chunkGroups: true,
 					modules: false,
 					chunks: true,
 					chunkModules: true,
@@ -1278,6 +1312,7 @@ class Stats {
 			case "detailed":
 				return {
 					entrypoints: true,
+					chunkGroups: true,
 					chunks: true,
 					chunkModules: false,
 					chunkOrigins: true,
diff --git a/lib/dependencies/ImportParserPlugin.js b/lib/dependencies/ImportParserPlugin.js
@@ -33,6 +33,23 @@ class ImportParserPlugin {
 
 			const importOptions = parser.getCommentOptions(expr.range);
 			if (importOptions) {
+				if (typeof importOptions.webpackIgnore !== "undefined") {
+					if (typeof importOptions.webpackIgnore !== "boolean") {
+						parser.state.module.warnings.push(
+							new UnsupportedFeatureWarning(
+								parser.state.module,
+								`\`webpackIgnore\` expected a boolean, but received: ${
+									importOptions.webpackIgnore
+								}.`
+							)
+						);
+					} else {
+						// Do not instrument `import()` is `webpackIgnore` is `true`
+						if (importOptions.webpackIgnore) {
+							return false;
+						}
+					}
+				}
 				if (typeof importOptions.webpackChunkName !== "undefined") {
 					if (typeof importOptions.webpackChunkName !== "string") {
 						parser.state.module.warnings.push(
diff --git a/lib/util/Queue.js b/lib/util/Queue.js
@@ -1,23 +1,46 @@
 "use strict";
 
-module.exports = class Queue {
+/**
+ * @template T
+ */
+class Queue {
+	/**
+	 * @param {IterableIterator<T>=} items The initial elements.
+	 */
 	constructor(items) {
+		/** @private @type {Set<T>} */
 		this.set = new Set(items);
+		/** @private @type {Iterator<T>} */
 		this.iterator = this.set[Symbol.iterator]();
 	}
 
+	/**
+	 * Returns the number of elements in this queue.
+	 * @return {number} The number of elements in this queue.
+	 */
 	get length() {
 		return this.set.size;
 	}
 
+	/**
+	 * Appends the specified element to this queue.
+	 * @param {T} item The element to add.
+	 * @return {void}
+	 */
 	enqueue(item) {
 		this.set.add(item);
 	}
 
+	/**
+	 * Retrieves and removes the head of this queue.
+	 * @return {T | undefined} The head of the queue of `undefined` if this queue is empty.
+	 */
 	dequeue() {
 		const result = this.iterator.next();
 		if (result.done) return undefined;
 		this.set.delete(result.value);
 		return result.value;
 	}
-};
+}
+
+module.exports = Queue;
diff --git a/lib/util/identifier.js b/lib/util/identifier.js
@@ -1,12 +1,33 @@
 "use strict";
 const path = require("path");
 
+/**
+ * @typedef {Object} MakeRelativePathsCache
+ * @property {Map<string, Map<string, string>>=} relativePaths
+ */
+
+/**
+ *
+ * @param {string} maybeAbsolutePath path to check
+ * @return {boolean} returns true if path is "Absolute Path"-like
+ */
 const looksLikeAbsolutePath = maybeAbsolutePath => {
 	return /^(?:[a-z]:\\|\/)/i.test(maybeAbsolutePath);
 };
 
+/**
+ *
+ * @param {string} p path to normalize
+ * @return {string} normalized version of path
+ */
 const normalizePathSeparator = p => p.replace(/\\/g, "/");
 
+/**
+ *
+ * @param {string} context context for relative path
+ * @param {string} identifier identifier for path
+ * @return {string} a converted relative path
+ */
 const _makePathsRelative = (context, identifier) => {
 	return identifier
 		.split(/([|! ])/)
@@ -19,6 +40,13 @@ const _makePathsRelative = (context, identifier) => {
 		.join("");
 };
 
+/**
+ *
+ * @param {string} context context used to create relative path
+ * @param {string} identifier identifier used to create relative path
+ * @param {MakeRelativePathsCache=} cache the cache object being set
+ * @return {string} the returned relative path
+ */
 exports.makePathsRelative = (context, identifier, cache) => {
 	if (!cache) return _makePathsRelative(context, identifier);
 
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
     "simple-git": "^1.65.0",
     "sinon": "^2.3.2",
     "style-loader": "^0.19.1",
-    "typescript": "^2.9.0-dev.20180412",
+    "typescript": "^2.9.0-dev.20180424",
     "url-loader": "^0.6.2",
     "val-loader": "^1.0.2",
     "vm-browserify": "~0.0.0",
@@ -88,7 +88,8 @@
     "buildin/",
     "hot/",
     "web_modules/",
-    "schemas/"
+    "schemas/",
+    "SECURITY.md"
   ],
   "scripts": {
     "setup": "node ./setup/setup.js",
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -1853,6 +1853,10 @@
               "type": "boolean",
               "description": "Display the entry points with the corresponding bundles"
             },
+            "chunkGroups": {
+              "type": "boolean",
+              "description": "Display all chunk groups with the corresponding bundles"
+            },
             "errorDetails": {
               "type": "boolean",
               "description": "add details to errors (like resolving log)"
diff --git a/test/Stats.unittest.js b/test/Stats.unittest.js
@@ -114,6 +114,7 @@ describe(
 					warnings: [],
 					assets: [],
 					entrypoints: new Map(),
+					namedChunkGroups: new Map(),
 					chunks: [],
 					modules: [],
 					children: [],
@@ -140,6 +141,7 @@ describe(
 					assets: [],
 					entrypoints: new Map(),
 					chunks: [],
+					namedChunkGroups: new Map(),
 					modules: [],
 					children: [],
 					hash: "1234",
@@ -160,6 +162,7 @@ describe(
 					children: [],
 					chunks: [],
 					entrypoints: {},
+					namedChunkGroups: {},
 					filteredAssets: 0,
 					filteredModules: 0,
 					errors: [],
diff --git a/test/configCases/parsing/import-ignore/index.js b/test/configCases/parsing/import-ignore/index.js
@@ -0,0 +1,9 @@
+const fs = require("fs");
+const path = require("path");
+const should = require("should");
+
+it("should be able to ignore import()", () => {
+	const source = fs.readFileSync(path.join(__dirname, "bundle1.js"), "utf-8");
+	should(source).containEql(`import(/* webpackIgnore: true */ "./other2.js")`);
+	should(source).not.containEql(`import(/* webpackIgnore: false */ "./other3.js")`);
+});
diff --git a/test/configCases/parsing/import-ignore/other.js b/test/configCases/parsing/import-ignore/other.js
@@ -0,0 +1,2 @@
+import(/* webpackIgnore: true */ "./other2.js");
+import(/* webpackIgnore: false */ "./other3.js");
diff --git a/test/configCases/parsing/import-ignore/other2.js b/test/configCases/parsing/import-ignore/other2.js
@@ -0,0 +1 @@
+export default "other2";
diff --git a/test/configCases/parsing/import-ignore/other3.js b/test/configCases/parsing/import-ignore/other3.js
@@ -0,0 +1 @@
+export default "other3";
diff --git a/test/configCases/parsing/import-ignore/webpack.config.js b/test/configCases/parsing/import-ignore/webpack.config.js
@@ -0,0 +1,12 @@
+module.exports = {
+	entry: {
+		bundle0: "./index.js",
+		bundle1: "./other.js"
+	},
+	output: {
+		filename: "[name].js"
+	},
+	node: {
+		__dirname: false
+	}
+};
diff --git a/test/statsCases/named-chunk-groups/a.js b/test/statsCases/named-chunk-groups/a.js
@@ -0,0 +1,3 @@
+import "./shared";
+
+export default "a";
diff --git a/test/statsCases/named-chunk-groups/b.js b/test/statsCases/named-chunk-groups/b.js
@@ -0,0 +1,3 @@
+import "./shared";
+
+export default "b";
diff --git a/test/statsCases/named-chunk-groups/c.js b/test/statsCases/named-chunk-groups/c.js
diff --git a/test/statsCases/named-chunk-groups/expected.txt b/test/statsCases/named-chunk-groups/expected.txt
diff --git a/test/statsCases/named-chunk-groups/index.js b/test/statsCases/named-chunk-groups/index.js
diff --git a/test/statsCases/named-chunk-groups/node_modules/x.js b/test/statsCases/named-chunk-groups/node_modules/x.js
diff --git a/test/statsCases/named-chunk-groups/node_modules/y.js b/test/statsCases/named-chunk-groups/node_modules/y.js
diff --git a/test/statsCases/named-chunk-groups/shared.js b/test/statsCases/named-chunk-groups/shared.js
diff --git a/test/statsCases/named-chunk-groups/webpack.config.js b/test/statsCases/named-chunk-groups/webpack.config.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+import(/* webpackIgnore: true */ "./other2.js");`
	`2`	`+import(/* webpackIgnore: false */ "./other3.js");`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import "./shared";`
	`2`	`+`
	`3`	`+export default "a";`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import "./shared";`
	`2`	`+`
	`3`	`+export default "b";`