Add buildEnvironment plugin option

Author: chuckd

README.md

@@ -179,6 +179,10 @@ This property is required and specifies the Dojo loader config.  See [The Dojo l
 
 Used only if the `loaderConfig` is a string specifying the name of a module and that module exports a function which returns the config.  The environment is passed to the function when it is called to get the config.  This should be a JSON type object because it gets stringified for export to the client.
 
+### buildEnvironment
+
+Simialr to `environment`, but used exclusively at build time.  If both are specified, then `buildEnvironment` will be passed to the `loaderConfig` function when building, and `environment` will be passed to the `loaderConfig` function when the built application is loaded in the browser.  This facilitates specifying different `loaderConfig` paths (e.g. `baseUrl`) for build vs. run.  If only `environment` is specified, then it is used for both.
+
 ### loader
 
 This property is optional and specifies the module path of the built Dojo loader.  See [Building the Dojo loader](#building-the-dojo-loader) for details.  If not specified, then the loader will be built as part of the Webpack build.

lib/DojoAMDPlugin.js

@@ -64,7 +64,7 @@ module.exports = class DojoAMDPlugin {
 			if (util.isString(this.options.loaderConfig)) {
 				loaderConfig = require(this.options.loaderConfig);
 				if (typeof loaderConfig === 'function') {
-					loaderConfig = loaderConfig(this.options.environment || {});
+					loaderConfig = loaderConfig(this.options.buildEnvironment || this.options.environment || {});
 				}
 			} else {
 				loaderConfig = this.options.loaderConfig;

package-lock.json

@@ -38,6 +38,6 @@
     "mocha": "^3.5.3",
     "mocha-lcov-reporter": "^1.3.0",
     "should": "^13.1.0",
-    "webpack": ">= 2.2.0"
+    "webpack": "3.7.1"
   }
 }

package.json

@@ -0,0 +1,8 @@
+define(["foo"], function(foo) {
+	it ("should load foo", function() {
+		foo.should.be.eql("foo");
+	});
+	it ("Should resolve foo as defined by environment", function() {
+		require.rawConfig.paths.foo.should.be.eql("/foo");
+	});
+});

test/TestCases/configLoading/buildEnv/index.js

@@ -0,0 +1,9 @@
+require("should");
+module.exports = function(env) {
+	it("foopath should be defined in environment", function() {
+		env.foopath.should.be.defined;
+	});
+	return {
+		paths: {foo: env.foopath}
+	};
+};

test/TestCases/configLoading/buildEnv/loaderConfig.js

@@ -0,0 +1,3 @@
+define([], function() {
+  return "foo";
+});

test/TestCases/configLoading/buildEnv/test/foo.js

@@ -0,0 +1,13 @@
+var path = require("path");
+var DojoWebpackPlugin = require("../../../../index");
+module.exports = {
+	entry: "./index",
+	plugins: [
+		new DojoWebpackPlugin({
+			loaderConfig: require.resolve("./loaderConfig"),
+			environment: {foopath: "/foo"},
+			buildEnvironment: {foopath: "test/foo"},
+			loader: path.join(__dirname, "../../../js/dojo/dojo.js")
+		})
+	]
+};

test/TestCases/configLoading/buildEnv/webpack.config.js

@@ -0,0 +1,8 @@
+define(["foo"], function(foo) {
+	it ("should load foo", function() {
+		foo.should.be.eql("foo");
+	});
+	it ("Should not resolve foo as defined by environment", function() {
+		(typeof require.rawConfig.paths.foo === 'undefined').should.be.true;
+	});
+});

test/TestCases/configLoading/buildEnvPlusEnv/index.js

@@ -0,0 +1,6 @@
+require("should");
+module.exports = function(env) {
+	return {
+		paths: {foo: env.foopath}
+	};
+};

test/TestCases/configLoading/buildEnvPlusEnv/loaderConfig.js

@@ -0,0 +1,3 @@
+define([], function() {
+  return "foo";
+});

test/TestCases/configLoading/buildEnvPlusEnv/test/foo.js

@@ -0,0 +1,12 @@
+var path = require("path");
+var DojoWebpackPlugin = require("../../../../index");
+module.exports = {
+	entry: "./index",
+	plugins: [
+		new DojoWebpackPlugin({
+			loaderConfig: require.resolve("./loaderConfig"),
+			buildEnvironment: {foopath: "test/foo"},
+			loader: path.join(__dirname, "../../../js/dojo/dojo.js")
+		})
+	]
+};

test/TestCases/configLoading/buildEnvPlusEnv/webpack.config.js

@@ -0,0 +1,8 @@
+define(["foo"], function(foo) {
+	it ("should load foo", function() {
+		foo.should.be.eql("foo");
+	});
+	it ("Should resolve foo as defined by environment", function() {
+		require.rawConfig.paths.foo.should.be.eql("test/foo");
+	});
+});

test/TestCases/configLoading/env/index.js

@@ -0,0 +1,9 @@
+require("should");
+module.exports = function(env) {
+	it("env should specify fooptah", function() {
+		env.foopath.should.be.eql("test/foo");
+	});
+	return {
+		paths: {foo: env.foopath}
+	};
+};

test/TestCases/configLoading/env/loaderConfig.js

@@ -0,0 +1,3 @@
+define([], function() {
+  return "foo";
+});

test/TestCases/configLoading/env/test/foo.js

@@ -0,0 +1,12 @@
+var path = require("path");
+var DojoWebpackPlugin = require("../../../../index");
+module.exports = {
+	entry: "./index",
+	plugins: [
+		new DojoWebpackPlugin({
+			loaderConfig: require.resolve("./loaderConfig"),
+			environment: {foopath: "test/foo"},
+			loader: path.join(__dirname, "../../../js/dojo/dojo.js")
+		})
+	]
+};

test/TestCases/configLoading/env/webpack.config.js

@@ -0,0 +1,5 @@
+define([], function() {
+	it ("Should resolve path as defined in loader config", function() {
+		require.toUrl('foo/bar').should.be.eql("/test/foo/bar");
+	});
+});

test/TestCases/configLoading/noenv/index.js

@@ -0,0 +1,9 @@
+require("should");
+module.exports = function(env) {
+	it("should have empty env", function() {
+		Object.keys(env).length.should.be.eql(0);
+	});
+	return {
+		paths: {foo: "/test/foo"}
+	};
+};

test/TestCases/configLoading/noenv/loaderConfig.js

@@ -0,0 +1,11 @@
+var path = require("path");
+var DojoWebpackPlugin = require("../../../../index");
+module.exports = {
+	entry: "./index",
+	plugins: [
+		new DojoWebpackPlugin({
+			loaderConfig: require.resolve("./loaderConfig"),
+			loader: path.join(__dirname, "../../../js/dojo/dojo.js")
+		})
+	]
+};

test/TestCases/configLoading/noenv/webpack.config.js

@@ -52,7 +52,7 @@ function runTestCases(casesPath, isErrorTest) {
 		describe(category.name, function() {
 			category.tests.forEach(function(testName) {
 				var suite = describe(testName, function() {});
-				it(testName + isErrorTest ? " should fail" : " should compile", function(done) {
+				it(testName + (isErrorTest ? " should fail" : " should compile"), function(done) {
 					this.timeout(60000);
 					var testDirectory = path.join(casesPath, category.name, testName);
 					var outputDirectory = path.join(__dirname, "js", "TestCases", category.name, testName);