Adding page argument to the Open option (#917)

TroyHisted · shellscape · commit 14d77a5c2d8f · 2017-06-15T20:53:54.000-04:00
* Adding page argument to the Open option

* Changing open argv comparison to be more explicite

* Adding open-page cli arg

* Making open-page require a value

* Adjusting openPage cli description
diff --git a/bin/webpack-dev-server.js b/bin/webpack-dev-server.js
@@ -91,6 +91,11 @@ yargs.options({
 		type: "boolean",
 		describe: "Open default browser"
 	},
+	"open-page": {
+		type: "string",
+		describe: "Open default browser with the specified page",
+		requiresArg: true,
+	},
 	"color": {
 		type: "boolean",
 		alias: "colors",
@@ -312,8 +317,10 @@ function processOptions(wpOpt) {
 	if(argv["compress"])
 		options.compress = true;
 
-	if(argv["open"])
+	if(argv["open"] || argv["open-page"]) {
 		options.open = true;
+		options.openPage = argv["open-page"] || "";
+	}
 
 	// Kind of weird, but ensures prior behavior isn't broken in cases
 	// that wouldn't throw errors. E.g. both argv.port and options.port
@@ -423,7 +430,7 @@ function reportReadiness(uri, options) {
 	if(options.historyApiFallback)
 		console.log(`404s will fallback to ${colorInfo(useColor, options.historyApiFallback.index || "/index.html")}`);
 	if(options.open) {
-		open(uri).catch(function() {
+		open(uri + options.openPage).catch(function() {
 			console.log("Unable to open browser. If you are running in a headless environment, please do not use the open flag.");
 		});
 	}
diff --git a/examples/cli-open-page/README.md b/examples/cli-open-page/README.md
@@ -0,0 +1,11 @@
+# CLI - OPEN-PAGE
+
+```shell
+node ../../bin/webpack-dev-server.js --open-page example.html#page1
+```
+
+Some applications may consist of multiple web pages. During development it may be useful to directly open a particular page. The page to open may be specified as the argument to the `open-page` option. 
+
+## What should happen
+
+The script should open `http://localhost:8080/example.html#page1`. In the app you should see "It's working."
diff --git a/examples/cli-open-page/app.js b/examples/cli-open-page/app.js
@@ -0,0 +1,3 @@
+if(window.location.href.endsWith("example.html#page1")) {
+	document.write("It's working.");
+}
diff --git a/examples/cli-open-page/example.html b/examples/cli-open-page/example.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<script src="bundle.js" type="text/javascript" charset="utf-8"></script>
+	</head>
+	<body>
+		<h1>Example: CLI - open-page</h1>
+	</body>
+</html>
diff --git a/examples/cli-open-page/webpack.config.js b/examples/cli-open-page/webpack.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+	context: __dirname,
+	entry: "./app.js",
+}
diff --git a/lib/optionsSchema.json b/lib/optionsSchema.json
@@ -192,9 +192,13 @@
       "type": "boolean"
     },
     "open": {
-      "description": "Let the CLI open your browser with the URL.",
+      "description": "Let the CLI open your browser.",
       "type": "boolean"
     },
+    "openPage": {
+      "description": "Let the CLI open your browser to a specific page on the site.",
+      "type": "string"
+    },
     "features": {
       "description": "The order of which the features will be triggered.",
       "items": {
diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -50,7 +50,7 @@ describe("Validation", function() {
 			" - configuration has an unknown property 'asdf'. These properties are valid:",
 			"   object { hot?, hotOnly?, lazy?, host?, allowedHosts?, filename?, publicPath?, port?, socket?, " +
 			"watchOptions?, headers?, clientLogLevel?, overlay?, key?, cert?, ca?, pfx?, pfxPassphrase?, " +
-			"inline?, disableHostCheck?, public?, https?, contentBase?, watchContentBase?, open?, features?, " +
+			"inline?, disableHostCheck?, public?, https?, contentBase?, watchContentBase?, open?, openPage?, features?, " +
 			"compress?, proxy?, historyApiFallback?, staticOptions?, setup?, stats?, reporter?, " +
 			"noInfo?, quiet?, serverSideRender?, index?, log?, warn? }"
 		]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+if(window.location.href.endsWith("example.html#page1")) {`
	`2`	`+ document.write("It's working.");`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ describe("Validation", function() {`
`50`	`50`	`" - configuration has an unknown property 'asdf'. These properties are valid:",`
`51`	`51`	`" object { hot?, hotOnly?, lazy?, host?, allowedHosts?, filename?, publicPath?, port?, socket?, " +`
`52`	`52`	`"watchOptions?, headers?, clientLogLevel?, overlay?, key?, cert?, ca?, pfx?, pfxPassphrase?, " +`
`53`		`- "inline?, disableHostCheck?, public?, https?, contentBase?, watchContentBase?, open?, features?, " +`
	`53`	`+ "inline?, disableHostCheck?, public?, https?, contentBase?, watchContentBase?, open?, openPage?, features?, " +`
`54`	`54`	`"compress?, proxy?, historyApiFallback?, staticOptions?, setup?, stats?, reporter?, " +`
`55`	`55`	`"noInfo?, quiet?, serverSideRender?, index?, log?, warn? }"`
`56`	`56`	`]`