live-server-maintained 0.0.0-stage → 0.1.1

package/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

package/.github/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+Contributing Guidelines
+=======================
+
+When implementing a new feature or a bugfix, consider these points:
+
+* Is this thing useful to other people, or is it just catering for an obscure corner case resulting from e.g. weirdness in personal dev environment?
+* Should the thing be live-server's responsibility at all, or is it better served by other tools?
+* Am I introducing unnecessary dependencies when the same thing could easily be done using normal JavaScript / node.js features?
+* Does the naming (e.g. command line parameters) make sense and uses same style as other similar ones?
+* Does my code adhere to the project's coding style (observable from surrounding code)?
+* Can backwards compatibility be preserved?
+
+A few guiding principles: keep the app simple and small, focusing on what it's meant to provide: live reloading development web server. Avoid extra dependencies and the need to do configuration when possible and it makes sense. Minimize bloat.
+
+If you are adding a feature, think about if it could be an extenral middleware instead, possible bundled with `live-server` in its `middleware` folder.
+
+**New features should come with test cases!**
+
+**Run `npm test` to check that you are not introducing new bugs or style issues!**

package/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+###### Before submitting an issue, please, see https://github.com/tapio/live-server#troubleshooting
+
+## Issue description
+
+## Software details
+
+* Command line used for launching `live-server`:
+* OS:
+* Browser (if browser related):
+* Node.js version:
+* `live-server` version:

package/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: node_js
+node_js:
+  - "node"
+  - "lts/*"

package/README.md

@@ -1,3 +1,13 @@
-# Temporary Holding Version
+# live-server-maintained
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An updated version of [live-server](https://github.com/tapio/live-server) with refreshed dependencies.
+
+The command is shortened from `live-server` to `lvm`:
+
+```bash
+lvm
+```
+
+Thats all you need to know.
+
+Original project created by [Tapio Vierros](https://github.com/tapio).

package/index.js

@@ -0,0 +1,403 @@
+#!/usr/bin/env node
+var fs = require('fs'),
+	connect = require('connect'),
+	serveIndex = require('serve-index'),
+	logger = require('morgan'),
+	WebSocket = require('faye-websocket'),
+	path = require('path'),
+	url = require('url'),
+	http = require('http'),
+	send = require('send'),
+	open = require('opn'),
+	es = require("event-stream"),
+	os = require('os'),
+	chokidar = require('chokidar');
+require('colors');
+
+var INJECTED_CODE = fs.readFileSync(path.join(__dirname, "injected.html"), "utf8");
+
+var LiveServer = {
+	server: null,
+	watcher: null,
+	logLevel: 2
+};
+
+function escape(html){
+	return String(html)
+		.replace(/&(?!\w+;)/g, '&')
+		.replace(/</g, '&lt;')
+		.replace(/>/g, '&gt;')
+		.replace(/"/g, '&quot;');
+}
+
+// Based on connect.static(), but streamlined and with added code injecter
+function staticServer(root) {
+	var isFile = false;
+	try { // For supporting mounting files instead of just directories
+		isFile = fs.statSync(root).isFile();
+	} catch (e) {
+		if (e.code !== "ENOENT") throw e;
+	}
+	return function(req, res, next) {
+		if (req.method !== "GET" && req.method !== "HEAD") return next();
+		var reqpath = isFile ? "" : url.parse(req.url).pathname;
+		var hasNoOrigin = !req.headers.origin;
+		var injectCandidates = [ new RegExp("</body>", "i"), new RegExp("</svg>"), new RegExp("</head>", "i")];
+		var injectTag = null;
+
+		function directory() {
+			var pathname = url.parse(req.originalUrl).pathname;
+			res.statusCode = 301;
+			res.setHeader('Location', pathname + '/');
+			res.end('Redirecting to ' + escape(pathname) + '/');
+		}
+
+		function file(filepath /*, stat*/) {
+			var x = path.extname(filepath).toLocaleLowerCase(), match,
+					possibleExtensions = [ "", ".html", ".htm", ".xhtml", ".php", ".svg" ];
+			if (hasNoOrigin && (possibleExtensions.indexOf(x) > -1)) {
+				// TODO: Sync file read here is not nice, but we need to determine if the html should be injected or not
+				var contents = fs.readFileSync(filepath, "utf8");
+				for (var i = 0; i < injectCandidates.length; ++i) {
+					match = injectCandidates[i].exec(contents);
+					if (match) {
+						injectTag = match[0];
+						break;
+					}
+				}
+				if (injectTag === null && LiveServer.logLevel >= 3) {
+					console.warn("Failed to inject refresh script!".yellow,
+						"Couldn't find any of the tags ", injectCandidates, "from", filepath);
+				}
+			}
+		}
+
+		function error(err) {
+			if (err.status === 404) return next();
+			next(err);
+		}
+
+		function inject(stream) {
+			if (injectTag) {
+				// We need to modify the length given to browser
+				var len = INJECTED_CODE.length + res.getHeader('Content-Length');
+				res.setHeader('Content-Length', len);
+				var originalPipe = stream.pipe;
+				stream.pipe = function(resp) {
+					originalPipe.call(stream, es.replace(new RegExp(injectTag, "i"), INJECTED_CODE + injectTag)).pipe(resp);
+				};
+			}
+		}
+
+		send(req, reqpath, { root: root })
+			.on('error', error)
+			.on('directory', directory)
+			.on('file', file)
+			.on('stream', inject)
+			.pipe(res);
+	};
+}
+
+/**
+ * Rewrite request URL and pass it back to the static handler.
+ * @param staticHandler {function} Next handler
+ * @param file {string} Path to the entry point file
+ */
+function entryPoint(staticHandler, file) {
+	if (!file) return function(req, res, next) { next(); };
+
+	return function(req, res, next) {
+		req.url = "/" + file;
+		staticHandler(req, res, next);
+	};
+}
+
+/**
+ * Start a live server with parameters given as an object
+ * @param host {string} Address to bind to (default: 0.0.0.0)
+ * @param port {number} Port number (default: 8080)
+ * @param root {string} Path to root directory (default: cwd)
+ * @param watch {array} Paths to exclusively watch for changes
+ * @param ignore {array} Paths to ignore when watching files for changes
+ * @param ignorePattern {regexp} Ignore files by RegExp
+ * @param noCssInject Don't inject CSS changes, just reload as with any other file change
+ * @param open {(string|string[])} Subpath(s) to open in browser, use false to suppress launch (default: server root)
+ * @param mount {array} Mount directories onto a route, e.g. [['/components', './node_modules']].
+ * @param logLevel {number} 0 = errors only, 1 = some, 2 = lots
+ * @param file {string} Path to the entry point file
+ * @param wait {number} Server will wait for all changes, before reloading
+ * @param htpasswd {string} Path to htpasswd file to enable HTTP Basic authentication
+ * @param middleware {array} Append middleware to stack, e.g. [function(req, res, next) { next(); }].
+ */
+LiveServer.start = function(options) {
+	options = options || {};
+	var host = options.host || '0.0.0.0';
+	var port = options.port !== undefined ? options.port : 8080; // 0 means random
+	var root = options.root || process.cwd();
+	var mount = options.mount || [];
+	var watchPaths = options.watch || [root];
+	LiveServer.logLevel = options.logLevel === undefined ? 2 : options.logLevel;
+	var openPath = (options.open === undefined || options.open === true) ?
+		"" : ((options.open === null || options.open === false) ? null : options.open);
+	if (options.noBrowser) openPath = null; // Backwards compatibility with 0.7.0
+	var file = options.file;
+	var staticServerHandler = staticServer(root);
+	var wait = options.wait === undefined ? 100 : options.wait;
+	var browser = options.browser || null;
+	var htpasswd = options.htpasswd || null;
+	var cors = options.cors || false;
+	var https = options.https || null;
+	var proxy = options.proxy || [];
+	var middleware = options.middleware || [];
+	var noCssInject = options.noCssInject;
+	var httpsModule = options.httpsModule;
+
+	if (httpsModule) {
+		try {
+			require.resolve(httpsModule);
+		} catch (e) {
+			console.error(("HTTPS module \"" + httpsModule + "\" you've provided was not found.").red);
+			console.error("Did you do", "\"npm install " + httpsModule + "\"?");
+			return;
+		}
+	} else {
+		httpsModule = "https";
+	}
+
+	// Setup a web server
+	var app = connect();
+
+	// Add logger. Level 2 logs only errors
+	if (LiveServer.logLevel === 2) {
+		app.use(logger('dev', {
+			skip: function (req, res) { return res.statusCode < 400; }
+		}));
+	// Level 2 or above logs all requests
+	} else if (LiveServer.logLevel > 2) {
+		app.use(logger('dev'));
+	}
+	if (options.spa) {
+		middleware.push("spa");
+	}
+	// Add middleware
+	middleware.map(function(mw) {
+		if (typeof mw === "string") {
+			var ext = path.extname(mw).toLocaleLowerCase();
+			if (ext !== ".js") {
+				mw = require(path.join(__dirname, "middleware", mw + ".js"));
+			} else {
+				mw = require(mw);
+			}
+		}
+		app.use(mw);
+	});
+
+	// Use http-auth if configured
+	if (htpasswd !== null) {
+		var auth = require('http-auth');
+		var basic = auth.basic({
+			realm: "Please authorize",
+			file: htpasswd
+		});
+		app.use(function(req, res, next) {
+			basic.check(function() {
+				next();
+			})(req, res);
+		});
+	}
+	if (cors) {
+		app.use(require("cors")({
+			origin: true, // reflecting request origin
+			credentials: true // allowing requests with credentials
+		}));
+	}
+	mount.forEach(function(mountRule) {
+		var mountPath = path.resolve(process.cwd(), mountRule[1]);
+		if (!options.watch) // Auto add mount paths to wathing but only if exclusive path option is not given
+			watchPaths.push(mountPath);
+		app.use(mountRule[0], staticServer(mountPath));
+		if (LiveServer.logLevel >= 1)
+			console.log('Mapping %s to "%s"', mountRule[0], mountPath);
+	});
+	proxy.forEach(function(proxyRule) {
+		var proxyOpts = url.parse(proxyRule[1]);
+		proxyOpts.via = true;
+		proxyOpts.preserveHost = true;
+		app.use(proxyRule[0], require('proxy-middleware')(proxyOpts));
+		if (LiveServer.logLevel >= 1)
+			console.log('Mapping %s to "%s"', proxyRule[0], proxyRule[1]);
+	});
+	app.use(staticServerHandler) // Custom static server
+		.use(entryPoint(staticServerHandler, file))
+		.use(serveIndex(root, { icons: true }));
+
+	var server, protocol;
+	if (https !== null) {
+		var httpsConfig = https;
+		if (typeof https === "string") {
+			httpsConfig = require(path.resolve(process.cwd(), https));
+		}
+		server = require(httpsModule).createServer(httpsConfig, app);
+		protocol = "https";
+	} else {
+		server = http.createServer(app);
+		protocol = "http";
+	}
+
+	// Handle server startup errors
+	server.addListener('error', function(e) {
+		if (e.code === 'EADDRINUSE') {
+			var serveURL = protocol + '://' + host + ':' + port;
+			console.log('%s is already in use. Trying another port.'.yellow, serveURL);
+			setTimeout(function() {
+				server.listen(0, host);
+			}, 1000);
+		} else {
+			console.error(e.toString().red);
+			LiveServer.shutdown();
+		}
+	});
+
+	// Handle successful server
+	server.addListener('listening', function(/*e*/) {
+		LiveServer.server = server;
+
+		var address = server.address();
+		var serveHost = address.address === "0.0.0.0" ? "127.0.0.1" : address.address;
+		var openHost = host === "0.0.0.0" ? "127.0.0.1" : host;
+
+		var serveURL = protocol + '://' + serveHost + ':' + address.port;
+		var openURL = protocol + '://' + openHost + ':' + address.port;
+
+		var serveURLs = [ serveURL ];
+		if (LiveServer.logLevel > 2 && address.address === "0.0.0.0") {
+			var ifaces = os.networkInterfaces();
+			serveURLs = Object.keys(ifaces)
+				.map(function(iface) {
+					return ifaces[iface];
+				})
+				// flatten address data, use only IPv4
+				.reduce(function(data, addresses) {
+					addresses.filter(function(addr) {
+						return addr.family === "IPv4";
+					}).forEach(function(addr) {
+						data.push(addr);
+					});
+					return data;
+				}, [])
+				.map(function(addr) {
+					return protocol + "://" + addr.address + ":" + address.port;
+				});
+		}
+
+		// Output
+		if (LiveServer.logLevel >= 1) {
+			if (serveURL === openURL)
+				if (serveURLs.length === 1) {
+					console.log(("Serving \"%s\" at %s").green, root, serveURLs[0]);
+				} else {
+					console.log(("Serving \"%s\" at\n\t%s").green, root, serveURLs.join("\n\t"));
+				}
+			else
+				console.log(("Serving \"%s\" at %s (%s)").green, root, openURL, serveURL);
+		}
+
+		// Launch browser
+		if (openPath !== null)
+			if (typeof openPath === "object") {
+				openPath.forEach(function(p) {
+					open(openURL + p, {app: browser});
+				});
+			} else {
+				open(openURL + openPath, {app: browser});
+			}
+	});
+
+	// Setup server to listen at port
+	server.listen(port, host);
+
+	// WebSocket
+	var clients = [];
+	server.addListener('upgrade', function(request, socket, head) {
+		var ws = new WebSocket(request, socket, head);
+		ws.onopen = function() { ws.send('connected'); };
+
+		if (wait > 0) {
+			(function() {
+				var wssend = ws.send;
+				var waitTimeout;
+				ws.send = function() {
+					var args = arguments;
+					if (waitTimeout) clearTimeout(waitTimeout);
+					waitTimeout = setTimeout(function(){
+						wssend.apply(ws, args);
+					}, wait);
+				};
+			})();
+		}
+
+		ws.onclose = function() {
+			clients = clients.filter(function (x) {
+				return x !== ws;
+			});
+		};
+
+		clients.push(ws);
+	});
+
+	var ignored = [
+		function(testPath) { // Always ignore dotfiles (important e.g. because editor hidden temp files)
+			return testPath !== "." && /(^[.#]|(?:__|~)$)/.test(path.basename(testPath));
+		}
+	];
+	if (options.ignore) {
+		ignored = ignored.concat(options.ignore);
+	}
+	if (options.ignorePattern) {
+		ignored.push(options.ignorePattern);
+	}
+	// Setup file watcher
+	LiveServer.watcher = chokidar.watch(watchPaths, {
+		ignored: ignored,
+		ignoreInitial: true
+	});
+	function handleChange(changePath) {
+		var cssChange = path.extname(changePath) === ".css" && !noCssInject;
+		if (LiveServer.logLevel >= 1) {
+			if (cssChange)
+				console.log("CSS change detected".magenta, changePath);
+			else console.log("Change detected".cyan, changePath);
+		}
+		clients.forEach(function(ws) {
+			if (ws)
+				ws.send(cssChange ? 'refreshcss' : 'reload');
+		});
+	}
+	LiveServer.watcher
+		.on("change", handleChange)
+		.on("add", handleChange)
+		.on("unlink", handleChange)
+		.on("addDir", handleChange)
+		.on("unlinkDir", handleChange)
+		.on("ready", function () {
+			if (LiveServer.logLevel >= 1)
+				console.log("Ready for changes".cyan);
+		})
+		.on("error", function (err) {
+			console.log("ERROR:".red, err);
+		});
+
+	return server;
+};
+
+LiveServer.shutdown = function() {
+	var watcher = LiveServer.watcher;
+	if (watcher) {
+		watcher.close();
+	}
+	var server = LiveServer.server;
+	if (server)
+		server.close();
+};
+
+module.exports = LiveServer;

package/injected.html

@@ -0,0 +1,31 @@
+<!-- Code injected by live-server -->
+<script type="text/javascript">
+	// <![CDATA[  <-- For SVG support
+	if ('WebSocket' in window) {
+		(function() {
+			function refreshCSS() {
+				var sheets = [].slice.call(document.getElementsByTagName("link"));
+				var head = document.getElementsByTagName("head")[0];
+				for (var i = 0; i < sheets.length; ++i) {
+					var elem = sheets[i];
+					head.removeChild(elem);
+					var rel = elem.rel;
+					if (elem.href && typeof rel != "string" || rel.length == 0 || rel.toLowerCase() == "stylesheet") {
+						var url = elem.href.replace(/(&|\?)_cacheOverride=\d+/, '');
+						elem.href = url + (url.indexOf('?') >= 0 ? '&' : '?') + '_cacheOverride=' + (new Date().valueOf());
+					}
+					head.appendChild(elem);
+				}
+			}
+			var protocol = window.location.protocol === 'http:' ? 'ws://' : 'wss://';
+			var address = protocol + window.location.host + window.location.pathname + '/ws';
+			var socket = new WebSocket(address);
+			socket.onmessage = function(msg) {
+				if (msg.data == 'reload') window.location.reload();
+				else if (msg.data == 'refreshcss') refreshCSS();
+			};
+			console.log('Live reload enabled.');
+		})();
+	}
+	// ]]>
+</script>

package/live-server.js

@@ -0,0 +1,174 @@
+#!/usr/bin/env node
+var path = require('path');
+var fs = require('fs');
+var assign = require('object-assign');
+var liveServer = require("./index");
+
+var opts = {
+	host: process.env.IP,
+	port: process.env.PORT,
+	open: true,
+	mount: [],
+	proxy: [],
+	middleware: [],
+	logLevel: 2,
+};
+
+var homeDir = process.env[(process.platform === 'win32') ? 'USERPROFILE' : 'HOME'];
+var configPath = path.join(homeDir, '.live-server.json');
+if (fs.existsSync(configPath)) {
+	var userConfig = fs.readFileSync(configPath, 'utf8');
+	assign(opts, JSON.parse(userConfig));
+	if (opts.ignorePattern) opts.ignorePattern = new RegExp(opts.ignorePattern);
+}
+
+for (var i = process.argv.length - 1; i >= 2; --i) {
+	var arg = process.argv[i];
+	if (arg.indexOf("--port=") > -1) {
+		var portString = arg.substring(7);
+		var portNumber = parseInt(portString, 10);
+		if (portNumber === +portString) {
+			opts.port = portNumber;
+			process.argv.splice(i, 1);
+		}
+	}
+	else if (arg.indexOf("--host=") > -1) {
+		opts.host = arg.substring(7);
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--open=") > -1) {
+		var open = arg.substring(7);
+		if (open.indexOf('/') !== 0) {
+			open = '/' + open;
+		}
+		switch (typeof opts.open) {
+			case "boolean":
+				opts.open = open;
+				break;
+			case "string":
+				opts.open = [opts.open, open];
+				break;
+			case "object":
+				opts.open.push(open);
+				break;
+		}
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--watch=") > -1) {
+		// Will be modified later when cwd is known
+		opts.watch = arg.substring(8).split(",");
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--ignore=") > -1) {
+		// Will be modified later when cwd is known
+		opts.ignore = arg.substring(9).split(",");
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--ignorePattern=") > -1) {
+		opts.ignorePattern = new RegExp(arg.substring(16));
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--no-css-inject") {
+		opts.noCssInject = true;
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--no-browser") {
+		opts.open = false;
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--browser=") > -1) {
+		opts.browser = arg.substring(10).split(",");
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--entry-file=") > -1) {
+		var file = arg.substring(13);
+		if (file.length) {
+			opts.file = file;
+			process.argv.splice(i, 1);
+		}
+	}
+	else if (arg === "--spa") {
+		opts.middleware.push("spa");
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--quiet" || arg === "-q") {
+		opts.logLevel = 0;
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--verbose" || arg === "-V") {
+		opts.logLevel = 3;
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--mount=") > -1) {
+		// e.g. "--mount=/components:./node_modules" will be ['/components', '<process.cwd()>/node_modules']
+		// split only on the first ":", as the path may contain ":" as well (e.g. C:\file.txt)
+		var match = arg.substring(8).match(/([^:]+):(.+)$/);
+		match[2] = path.resolve(process.cwd(), match[2]);
+		opts.mount.push([ match[1], match[2] ]);
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--wait=") > -1) {
+		var waitString = arg.substring(7);
+		var waitNumber = parseInt(waitString, 10);
+		if (waitNumber === +waitString) {
+			opts.wait = waitNumber;
+			process.argv.splice(i, 1);
+		}
+	}
+	else if (arg === "--version" || arg === "-v") {
+		var packageJson = require('./package.json');
+		console.log(packageJson.name, packageJson.version);
+		process.exit();
+	}
+	else if (arg.indexOf("--htpasswd=") > -1) {
+		opts.htpasswd = arg.substring(11);
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--cors") {
+		opts.cors = true;
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--https=") > -1) {
+		opts.https = arg.substring(8);
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--https-module=") > -1) {
+		opts.httpsModule = arg.substring(15);
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--proxy=") > -1) {
+		// split only on the first ":", as the URL will contain ":" as well
+		var match = arg.substring(8).match(/([^:]+):(.+)$/);
+		opts.proxy.push([ match[1], match[2] ]);
+		process.argv.splice(i, 1);
+	}
+	else if (arg.indexOf("--middleware=") > -1) {
+		opts.middleware.push(arg.substring(13));
+		process.argv.splice(i, 1);
+	}
+	else if (arg === "--help" || arg === "-h") {
+		console.log('Usage: live-server [-v|--version] [-h|--help] [-q|--quiet] [--port=PORT] [--host=HOST] [--open=PATH] [--no-browser] [--browser=BROWSER] [--ignore=PATH] [--ignorePattern=RGXP] [--no-css-inject] [--entry-file=PATH] [--spa] [--mount=ROUTE:PATH] [--wait=MILLISECONDS] [--htpasswd=PATH] [--cors] [--https=PATH] [--https-module=MODULE_NAME] [--proxy=PATH] [PATH]');
+		process.exit();
+	}
+	else if (arg === "--test") {
+		// Hidden param for tests to exit automatically
+		setTimeout(liveServer.shutdown, 500);
+		process.argv.splice(i, 1);
+	}
+}
+
+// Patch paths
+var dir = opts.root = process.argv[2] || "";
+
+if (opts.watch) {
+	opts.watch = opts.watch.map(function(relativePath) {
+		return path.join(dir, relativePath);
+	});
+}
+if (opts.ignore) {
+	opts.ignore = opts.ignore.map(function(relativePath) {
+		return path.join(dir, relativePath);
+	});
+}
+
+liveServer.start(opts);

package/middleware/example.js

@@ -0,0 +1,5 @@
+module.exports = function(req, res, next) {
+	res.statusCode = 202;
+	next();
+}
+