@nitro/app 11.0.0-beta.1 → 11.0.0-beta.2

package/app/core/config.js

@@ -39,6 +39,7 @@ const defaultConfig = {
 	},
 	server: {
 		port: 8080,
+		host: 'localhost',
 		production: !!(process.env.NODE_ENV && process.env.NODE_ENV.replace(/\s/g, '') === 'production'),
 		compression: true,
 		projectPaths: [
@@ -46,7 +47,6 @@ const defaultConfig = {
 			'project/helpers',
 			'project/locales',
 			'project/routes',
-			'project/server',
 			'project/viewData',
 			'public',
 			'src/views',

package/app/core/listen.js

@@ -5,18 +5,38 @@ const mode = config.get('server.production') ? 'production' : 'development';
 const port = config.get('server.port');
 
 /* eslint-disable no-console */
-module.exports = function (app) {
-	app.listen(port, () => {
-		console.log('---------------------------------------------');
-		console.log('Nitro listening on *:%s in %s mode', port, mode);
-		console.log('---------------------------------------------');
-	}).on('error', (err) => {
-		if (err.errno === 'EADDRINUSE') {
-			console.error('Port *:%s already in use.', port);
-		} else {
-			console.error(err);
-		}
-		process.exit(1);
-	});
+module.exports = function (app, opts = {}) {
+	const rawHost = (config.has('server.host')) ? config.get('server.host') : 'localhost';
+	const host = ['0.0.0.0', '::', '::0'].includes(String(rawHost)) ? 'localhost' : rawHost;
+	const url = `http://${host}:${port}`;
+	const openBrowser = opts.open; // true | false | string (URL)
+
+	const server = app
+		.listen(port, () => {
+			console.log('-------------------------------------------------------------------');
+			console.log('Nitro listening on %s in %s mode', url, mode);
+			console.log('-------------------------------------------------------------------');
+
+			if (openBrowser) {
+				const openUrl = typeof openBrowser === 'string' ? openBrowser : url;
+				(async () => {
+					try {
+						const mod = await import('open');
+						const open = mod.default;
+						await open(openUrl, { wait: false });
+					} catch (e) { /* empty */}
+				})();
+			}
+		})
+		.on('error', (err) => {
+			if (err && err.errno === 'EADDRINUSE') {
+				console.error('Port *:%s already in use.', port);
+			} else {
+				console.error(err);
+			}
+			process.exit(1);
+		});
+
+	return server;
 };
 /* eslint-enable no-console */

package/app/scripts/server.js

@@ -7,9 +7,14 @@ const router = require('../core/router');
 const compression = require('compression');
 const bodyParser = require('body-parser');
 
+// CLI flags (only --open[=URL] or --open URL)
+const { parseOpenArg } = require('./util/cliOpen');
+const { open } = parseOpenArg(process.argv.slice(2));
+
 const isProduction = config.get('server.production');
 const useCompression = config.get('server.compression');
 const isTwig = config.get('nitro.templateEngine') === 'twig';
+
 let engine;
 
 // webpack
@@ -47,4 +52,4 @@ if (isTwig) {
 	app.engine(config.get('nitro.viewFileExtension'), engine.__express);
 }
 
-require('../core/listen')(app);
+require('../core/listen')(app, { open });

package/app/scripts/util/cliOpen.js

@@ -0,0 +1,35 @@
+'use strict';
+
+function strip(s) {
+	return s.replace(/^['"]|['"]$/g, '');
+}
+
+function parseOpenArg(args) {
+	for (let i = 0; i < args.length; i++) {
+		const a = args[i];
+
+		// case 1: "--open"
+		if (a === '--open') {
+			const next = args[i + 1];
+
+			// case 2: "--open http://somehost"
+			if (next && !next.startsWith('-')) {
+				return { open: strip(next) };
+			}
+
+			return { open: true };
+		}
+
+		// case 3: "--open=http://somehost"
+		if (a.startsWith('--open=')) {
+			const url = a.slice('--open='.length).trim();
+			return { open: strip(url) };
+		}
+	}
+
+	return { open: false };
+}
+
+module.exports = {
+	parseOpenArg
+};

package/bin/serve.js

@@ -1,3 +1,28 @@
 #!/usr/bin/env node
 
+/**
+ * CLI flag `--open` opens a browser after starting the server
+ *   --open
+ *   --open <url>
+ *   --open=<url>
+ *
+ * If the flag is provided without a URL, the URL to open is computed by `../app/core/listen`.
+ * If a URL is provided, it overrides the computed URL.
+ *
+ * Examples
+ *
+ * # 1) start nitro server
+ * nitro-app-serve
+ *
+ * # 2) ... and opens computed URL in browser
+ * nitro-app-serve --open
+ *
+ * # 3) ... and opens exact URL in browser
+ * nitro-app-serve --open http://localhost:5050/styleguide
+ *
+ * # 4) also valid
+ * nitro-app-serve --open=https://local:3000/documentation
+ *
+ */
+
 require('../app/scripts/server.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitro/app",
-  "version": "11.0.0-beta.1",
+  "version": "11.0.0-beta.2",
   "description": "Nitro server",
   "license": "MIT",
   "repository": {
@@ -51,6 +51,7 @@
     "i18next-sprintf-postprocessor": "0.2.2",
     "jasmine": "6.0.0",
     "lodash": "4.17.23",
+    "open": "11.0.0",
     "twig": "1.13.3",
     "webpack-dev-middleware": "7.4.5",
     "webpack-hot-middleware": "2.26.1"