Add specify chunk name feature for import()

mc-zone · mc-zone · commit b65432a2f1d0 · 2017-03-26T17:18:30.000+08:00
Add specify chunk name feature for `import()` by following special comment block after the param:

  import('./foo' /* webpackChunkName = "myChunkName" */)

Thus we can use chunk name like `requre.ensure` and avoid conflicts with the specification.
diff --git a/lib/ContextModule.js b/lib/ContextModule.js
@@ -10,7 +10,7 @@ const RawSource = require("webpack-sources").RawSource;
 const AsyncDependenciesBlock = require("./AsyncDependenciesBlock");
 
 class ContextModule extends Module {
-	constructor(resolveDependencies, context, recursive, regExp, addon, isAsync) {
+	constructor(resolveDependencies, context, recursive, regExp, addon, isAsync, chunkName) {
 		super();
 		this.resolveDependencies = resolveDependencies;
 		this.context = context;
@@ -21,6 +21,7 @@ class ContextModule extends Module {
 		this.cacheable = true;
 		this.contextDependencies = [context];
 		this.built = false;
+		this.chunkName = chunkName;
 	}
 
 	prettyRegExp(regexString) {
@@ -125,7 +126,7 @@ class ContextModule extends Module {
 			// if we are async however create a new async dependency block
 			// and add that block to this context
 			dependencies.forEach(dep => {
-				const block = new AsyncDependenciesBlock(null, dep.module, dep.loc);
+				const block = new AsyncDependenciesBlock(this.chunkName, dep.module, dep.loc);
 				block.addDependency(dep);
 				this.addBlock(block);
 			});
diff --git a/lib/ContextModuleFactory.js b/lib/ContextModuleFactory.js
@@ -23,6 +23,7 @@ ContextModuleFactory.prototype.create = function(data, callback) {
 	var context = data.context;
 	var dependencies = data.dependencies;
 	var dependency = dependencies[0];
+
 	this.applyPluginsAsyncWaterfall("before-resolve", {
 		context: context,
 		request: dependency.request,
@@ -93,7 +94,7 @@ ContextModuleFactory.prototype.create = function(data, callback) {
 				// Ignored
 				if(!result) return callback();
 
-				return callback(null, new ContextModule(result.resolveDependencies, result.resource, result.recursive, result.regExp, result.loaders, result.async));
+				return callback(null, new ContextModule(result.resolveDependencies, result.resource, result.recursive, result.regExp, result.loaders, result.async, dependency.chunkName));
 			});
 		});
 	});
diff --git a/lib/dependencies/ContextDependencyHelpers.js b/lib/dependencies/ContextDependencyHelpers.js
@@ -13,7 +13,7 @@ function quotemeta(str) {
 	return str.replace(/[-[\]\\/{}()*+?.^$|]/g, "\\$&");
 }
 
-ContextDependencyHelpers.create = function(Dep, range, param, expr, options) {
+ContextDependencyHelpers.create = function(Dep, range, param, expr, options, chunkName) {
 	var dep, prefix, postfix, prefixRange, valueRange, idx, context, regExp;
 	if(param.isTemplateString()) {
 		prefix = param.quasis[0].string;
@@ -31,7 +31,7 @@ ContextDependencyHelpers.create = function(Dep, range, param, expr, options) {
 			quotemeta(prefix) +
 			options.wrappedContextRegExp.source +
 			quotemeta(postfix) + "$");
-		dep = new Dep(context, options.wrappedContextRecursive, regExp, range, valueRange);
+		dep = new Dep(context, options.wrappedContextRecursive, regExp, range, valueRange, chunkName);
 		dep.loc = expr.loc;
 		dep.replaces = [{
 			range: prefixRange,
@@ -54,13 +54,13 @@ ContextDependencyHelpers.create = function(Dep, range, param, expr, options) {
 			quotemeta(prefix) +
 			options.wrappedContextRegExp.source +
 			quotemeta(postfix) + "$");
-		dep = new Dep(context, options.wrappedContextRecursive, regExp, range, valueRange);
+		dep = new Dep(context, options.wrappedContextRecursive, regExp, range, valueRange, chunkName);
 		dep.loc = expr.loc;
 		dep.prepend = param.prefix && param.prefix.isString() ? prefix : null;
 		dep.critical = options.wrappedContextCritical && "a part of the request of a dependency is an expression";
 		return dep;
 	} else {
-		dep = new Dep(options.exprContextRequest, options.exprContextRecursive, options.exprContextRegExp, range, param.range);
+		dep = new Dep(options.exprContextRequest, options.exprContextRecursive, options.exprContextRegExp, range, param.range, chunkName);
 		dep.loc = expr.loc;
 		dep.critical = options.exprContextCritical && "the request of a dependency is an expression";
 		return dep;
diff --git a/lib/dependencies/ImportContextDependency.js b/lib/dependencies/ImportContextDependency.js
@@ -8,11 +8,12 @@ const CriticalDependencyWarning = require("./CriticalDependencyWarning");
 const ContextDependencyTemplateAsRequireCall = require("./ContextDependencyTemplateAsRequireCall");
 
 class ImportContextDependency extends ContextDependency {
-	constructor(request, recursive, regExp, range, valueRange) {
+	constructor(request, recursive, regExp, range, valueRange, chunkName) {
 		super(request, recursive, regExp);
 		this.range = range;
 		this.valueRange = valueRange;
 		this.async = true;
+		this.chunkName = chunkName;
 	}
 
 	get type() {
diff --git a/lib/dependencies/ImportDependenciesBlock.js b/lib/dependencies/ImportDependenciesBlock.js
@@ -7,8 +7,8 @@ const AsyncDependenciesBlock = require("../AsyncDependenciesBlock");
 const ImportDependency = require("./ImportDependency");
 
 module.exports = class ImportDependenciesBlock extends AsyncDependenciesBlock {
-	constructor(request, range, module, loc) {
-		super(null, module, loc);
+	constructor(request, range, chunkName, module, loc) {
+		super(chunkName, module, loc);
 		this.range = range;
 		const dep = new ImportDependency(request, this);
 		dep.loc = loc;
diff --git a/lib/dependencies/ImportParserPlugin.js b/lib/dependencies/ImportParserPlugin.js
@@ -15,16 +15,56 @@ class ImportParserPlugin {
 
 	apply(parser) {
 		const options = this.options;
+		let parsedComments, chunkNameAssignment;
+
+		parser.plugin("program", (ast, comments) => {
+			parsedComments = comments;
+		});
+
+		// use /* webpackChunkName = "chunkName" */ to specify a chunkName
+		parser.plugin("evaluate AssignmentExpression", (assignment) => {
+			if(assignment.left.name === "webpackChunkName") {
+				chunkNameAssignment = assignment;
+			}
+		});
+
 		parser.plugin(["call System.import", "import-call"], (expr) => {
 			if(expr.arguments.length !== 1)
 				throw new Error("Incorrect number of arguments provided to 'import(module: string) -> Promise'.");
+
 			const param = parser.evaluateExpression(expr.arguments[0]);
+			const exprEndPos = expr.end;
+			const paramEndPos = expr.arguments[0].end;
+			let chunkName = null;
+
+			//check chunkName from comments
+			if(parsedComments.length && exprEndPos - paramEndPos > "/*webpackChunkName=*/".length) {
+				for(let i = 0; i < parsedComments.length; i++) {
+					let comment = parsedComments[i];
+					// should match the location and length
+					if(comment.type === "Block" && comment.start >= paramEndPos && comment.end < exprEndPos) {
+						chunkNameAssignment = null;
+						parser.evaluate(comment.value);
+						// expect an AssignmentExpression after evaluate
+						if(chunkNameAssignment) {
+							const chunkNameExpr = parser.evaluateExpression(chunkNameAssignment.right);
+							if(chunkNameExpr.isString()) {
+								chunkName = chunkNameExpr.string;
+							} else {
+								throw new Error(`\`webpackChunkName\` expected a String, but received: ${comment.value} .`);
+							}
+						}
+						break;
+					}
+				}
+			}
+
 			if(param.isString()) {
-				const depBlock = new ImportDependenciesBlock(param.string, expr.range, parser.state.module, expr.loc);
+				const depBlock = new ImportDependenciesBlock(param.string, expr.range, chunkName, parser.state.module, expr.loc);
 				parser.state.current.addBlock(depBlock);
 				return true;
 			} else {
-				const dep = ContextDependencyHelpers.create(ImportContextDependency, expr.range, param, expr, options);
+				const dep = ContextDependencyHelpers.create(ImportContextDependency, expr.range, param, expr, options, chunkName);
 				if(!dep) return;
 				dep.loc = expr.loc;
 				dep.optional = !!parser.scope.inTry;
