webpack-dev-server 2.4.2 → 2.5.0

package/LICENSE

@@ -1,20 +1,20 @@
-Copyright JS Foundation and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,86 +1,86 @@
-# webpack-dev-server
-
-[![npm][npm]][npm-url]
-[![node][node]][node-url]
-[![deps][deps]][deps-url]
-[![tests][tests]][tests-url]
-[![coverage][cover]][cover-url]
-[![chat][chat]][chat-url]
-
-<div align="center">
-  <a href="https://github.com/webpack/webpack">
-    <img width="200" height="200"
-      src="https://webpack.js.org/assets/icon-square-big.svg">
-  </a>
-  <h1>webpack Dev Server</h1>
-</div>
-
-Use [webpack](https://webpack.js.org) with a development server that provides live reloading. This should be used for **development only**.
-
-It uses [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) under the hood, which provides fast in-memory access to the webpack assets.
-
-<h2 align="center">Install</h2>
-
-```
-npm install webpack-dev-server --save-dev
-```
-
-<h2 align="center">Usage</h2>
-
-The easiest way to use it is with the CLI. In the directory where your `webpack.config.js` is, run:
-
-```
-node_modules/.bin/webpack-dev-server
-```
-
-This will start a server, listening on connections from `localhost` on port `8080`.
-
-Now, when you change something in your assets, it should live-reload the files.
-
-See [**the documentation**](https://webpack.js.org/configuration/dev-server/#devserver) for more use cases and options.
-
-<h2 align="center">Contributing</h2>
-
-We appreciate all help! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help.
-
-<h2 align="center">Maintainers</h2>
-
-<table>
-  <tbody>
-    <tr>
-      <td align="center">
-        <img width="150" height="150"
-        src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
-        <br />
-        <a href="https://github.com/">Kees Kluskens</a>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-<h2 align="center">Inspiration</h2>
-
-This project is heavily inspired by [peerigon/nof5](https://github.com/peerigon/nof5).
-
-<h2 align="center">LICENSE</h2>
-
-#### [MIT](./LICENSE)
-
-
-[npm]: https://img.shields.io/npm/v/webpack-dev-server.svg
-[npm-url]: https://npmjs.com/package/webpack-dev-server
-
-[node]: https://img.shields.io/node/v/webpack-dev-server.svg
-[node-url]: https://nodejs.org
-
-[deps]: https://david-dm.org/webpack/webpack-dev-server.svg
-[deps-url]: https://david-dm.org/webpack/webpack-dev-server
-
-[tests]: http://img.shields.io/travis/webpack/webpack-dev-server.svg
-[tests-url]: https://travis-ci.org/webpack/webpack-dev-server
-
-[cover]: https://codecov.io/gh/webpack/webpack-dev-server/branch/master/graph/badge.svg
-[cover-url]: https://codecov.io/gh/webpack/webpack-dev-server
-
-[chat]: https://badges.gitter.im/webpack/webpack.svg
-[chat-url]: https://gitter.im/webpack/webpack
+# webpack-dev-server
+
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
+
+<div align="center">
+  <a href="https://github.com/webpack/webpack">
+    <img width="200" height="200"
+      src="https://webpack.js.org/assets/icon-square-big.svg">
+  </a>
+  <h1>webpack Dev Server</h1>
+</div>
+
+Use [webpack](https://webpack.js.org) with a development server that provides live reloading. This should be used for **development only**.
+
+It uses [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) under the hood, which provides fast in-memory access to the webpack assets.
+
+<h2 align="center">Install</h2>
+
+```
+npm install webpack-dev-server --save-dev
+```
+
+<h2 align="center">Usage</h2>
+
+The easiest way to use it is with the CLI. In the directory where your `webpack.config.js` is, run:
+
+```
+node_modules/.bin/webpack-dev-server
+```
+
+This will start a server, listening on connections from `localhost` on port `8080`.
+
+Now, when you change something in your assets, it should live-reload the files.
+
+See [**the documentation**](https://webpack.js.org/configuration/dev-server/#devserver) for more use cases and options.
+
+<h2 align="center">Contributing</h2>
+
+We appreciate all help! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help.
+
+<h2 align="center">Maintainers</h2>
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://avatars.githubusercontent.com/SpaceK33z?v=3">
+        <br />
+        <a href="https://github.com/">Kees Kluskens</a>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2 align="center">Inspiration</h2>
+
+This project is heavily inspired by [peerigon/nof5](https://github.com/peerigon/nof5).
+
+<h2 align="center">LICENSE</h2>
+
+#### [MIT](./LICENSE)
+
+
+[npm]: https://img.shields.io/npm/v/webpack-dev-server.svg
+[npm-url]: https://npmjs.com/package/webpack-dev-server
+
+[node]: https://img.shields.io/node/v/webpack-dev-server.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://david-dm.org/webpack/webpack-dev-server.svg
+[deps-url]: https://david-dm.org/webpack/webpack-dev-server
+
+[tests]: http://img.shields.io/travis/webpack/webpack-dev-server.svg
+[tests-url]: https://travis-ci.org/webpack/webpack-dev-server
+
+[cover]: https://codecov.io/gh/webpack/webpack-dev-server/branch/master/graph/badge.svg
+[cover-url]: https://codecov.io/gh/webpack/webpack-dev-server
+
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack

package/bin/webpack-dev-server.js

@@ -8,6 +8,7 @@ const net = require("net");
 const portfinder = require("portfinder");
 const addDevServerEntrypoints = require("../lib/util/addDevServerEntrypoints");
 const createDomain = require("../lib/util/createDomain");
+const bonjour = require("bonjour")();
 
 // Local version replaces global one
 try {
@@ -39,6 +40,8 @@ function colorError(useColor, msg) {
 	return msg;
 }
 
+const defaultTo = (value, def) => value == null ? def : value;
+
 const yargs = require("yargs")
 	.usage(`${versionInfo()
 		}\nUsage: https://webpack.js.org/configuration/dev-server/`);
@@ -62,6 +65,10 @@ const BASIC_GROUP = "Basic options:";
 const DEFAULT_PORT = 8080;
 
 yargs.options({
+	"bonjour": {
+		type: "boolean",
+		describe: "Broadcasts the server via ZeroConf networking on start"
+	},
 	"lazy": {
 		type: "boolean",
 		describe: "Lazy"
@@ -89,6 +96,15 @@ yargs.options({
 		type: "boolean",
 		describe: "Open default browser"
 	},
+	"useLocalIp": {
+		type: "boolean",
+		describe: "Open default browser with local IP"
+	},
+	"open-page": {
+		type: "string",
+		describe: "Open default browser with the specified page",
+		requiresArg: true,
+	},
 	"color": {
 		type: "boolean",
 		alias: "colors",
@@ -207,6 +223,9 @@ function processOptions(wpOpt) {
 
 	const options = wpOpt.devServer || firstWpOpt.devServer || {};
 
+	if(argv.bonjour)
+		options.bonjour = true;
+
 	if(argv.host !== "localhost" || !options.host)
 		options.host = argv.host;
 
@@ -310,15 +329,20 @@ 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"] || "";
+	}
+
+	if(argv["useLocalIp"])
+		options.useLocalIp = true;
 
 	// 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
 	// were specified, but since argv.port is 8080, options.port will be
 	// tried first instead.
-	options.port = argv.port === DEFAULT_PORT ? (options.port || argv.port) : (argv.port || options.port);
-	if(options.port) {
+	options.port = argv.port === DEFAULT_PORT ? defaultTo(options.port, argv.port) : defaultTo(argv.port, options.port);
+	if(options.port != null) {
 		startDevServer(wpOpt, options);
 		return;
 	}
@@ -401,6 +425,7 @@ function startDevServer(wpOpt, options) {
 	} else {
 		server.listen(options.port, options.host, function(err) {
 			if(err) throw err;
+			if(options.bonjour) broadcastZeroconf(options);
 			reportReadiness(uri, options);
 		});
 	}
@@ -421,10 +446,26 @@ 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.");
 		});
 	}
+	if(options.bonjour)
+		console.log("Broadcasting \"http\" with subtype of \"webpack\" via ZeroConf DNS (Bonjour)");
+}
+
+function broadcastZeroconf(options) {
+	bonjour.publish({
+		name: "Webpack Dev Server",
+		port: options.port,
+		type: "http",
+		subtypes: ["webpack"]
+	});
+	process.on("exit", function() {
+		bonjour.unpublishAll(function() {
+			bonjour.destroy();
+		});
+	});
 }
 
 processOptions(wpOpt);