@nitro/app 10.0.4 → 11.0.0-beta.2

package/app/core/config.js

@@ -19,7 +19,6 @@ const defaultConfig = {
 		templateEngine: 'hbs',
 		mode: {
 			livereload: true,
-			offline: false,
 			test: !!(process.env.NITRO_MODE && process.env.NITRO_MODE.replace(/\s/g, '') === 'test'),
 		},
 		watch: {
@@ -40,10 +39,7 @@ const defaultConfig = {
 	},
 	server: {
 		port: 8080,
-		proxy: {
-			port: 8081,
-			https: false,
-		},
+		host: 'localhost',
 		production: !!(process.env.NODE_ENV && process.env.NODE_ENV.replace(/\s/g, '') === 'production'),
 		compression: true,
 		projectPaths: [
@@ -51,7 +47,6 @@ const defaultConfig = {
 			'project/helpers',
 			'project/locales',
 			'project/routes',
-			'project/server',
 			'project/viewData',
 			'public',
 			'src/views',
@@ -125,6 +120,7 @@ const defaultConfig = {
 					lookupQuerystring: 'lang',
 				},
 				// compatibilityJSON: 'v3',
+				showSupportNotice: false,
 				debug: false
 			},
 			middlewareOptions: {

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/core/router.js

@@ -15,7 +15,6 @@ const router = express.Router({
 });
 const isProduction = config.get('server.production');
 const isTest = config.get('nitro.mode.test');
-const isOffline = config.get('nitro.mode.offline');
 const view404 = config.get('nitro.view404');
 
 /**
@@ -34,7 +33,6 @@ function getNitroViewData(pageTitle, req) {
 			pageTitle,
 			production: isProduction,
 			test: isTest,
-			offline: isOffline,
 		},
 	};
 }

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/app/scripts/validate-pattern-data.js

@@ -24,81 +24,86 @@
  */
 const clc = require('cli-color');
 const fs = require('fs');
-const globby = require('globby');
 const Ajv = require('ajv');
-const ajv = new Ajv({ allErrors: true });
 const config = require('config');
-const wildcard = '*';
-const patternBasePaths = Object.keys(config.get('nitro.patterns')).map((key) => {
-	return config.get(`nitro.patterns.${key}.path`);
-});
-const patternGlobs = patternBasePaths
-	.map((patternBasePath) => {
-		return `${patternBasePath}/${wildcard}`;
-	})
-	.concat(
-		patternBasePaths.map((patternBasePath) => {
-			return `${patternBasePath}/${wildcard}/elements/${wildcard}`;
-		})
+
+(async () => {
+
+	const { globbySync } = await import('globby');
+
+	const ajv = new Ajv({ allErrors: true });
+	const wildcard = '*';
+
+	const patternBasePaths = Object.keys(config.get('nitro.patterns')).map((key) =>
+		config.get(`nitro.patterns.${key}.path`)
 	);
-const logMissingSchemaAsError = config.has('code.validation.jsonSchema.logMissingSchemaAsError')
-	? config.get('code.validation.jsonSchema.logMissingSchemaAsError')
-	: false;
-const logMissingSchemaAsWarning = config.has('code.validation.jsonSchema.logMissingSchemaAsWarning')
-	? config.get('code.validation.jsonSchema.logMissingSchemaAsWarning')
-	: true;
-
-let errorCouter = 0;
-let patternCouter = 0;
-
-// collect all schemas
-globby.sync(patternGlobs, { onlyFiles: false }).forEach((patternPath) => {
-	const schemaFilePath = `${patternPath}/schema.json`;
-
-	if (fs.existsSync(schemaFilePath)) {
-		// console.log(`Add ${schemaFilePath}`);
-		const schema = JSON.parse(fs.readFileSync(schemaFilePath, 'utf8'));
-		if (schema.$id) {
-			// ajv.addSchema(schema);
-			ajv.addMetaSchema(schema);
-		}
-	}
-});
-
-// validate pattern data
-globby.sync(patternGlobs, { onlyFiles: false }).forEach((patternPath) => {
-	const schemaFilePath = `${patternPath}/schema.json`;
-	patternCouter += 1;
-
-	if (!fs.existsSync(schemaFilePath)) {
-		if (logMissingSchemaAsError) {
-			console.log(`${clc.red('Error')} (${patternPath}): no schema file found`);
-			errorCouter += 1;
-			return true;
-		}
-		if (logMissingSchemaAsWarning) {
-			console.log(`${clc.yellow('Warn')} (${patternPath}): no schema file found`);
+
+	const patternGlobs = patternBasePaths
+		.map((p) => `${p}/${wildcard}`)
+		.concat(patternBasePaths.map((p) => `${p}/${wildcard}/elements/${wildcard}`));
+
+	const logMissingSchemaAsError = config.has('code.validation.jsonSchema.logMissingSchemaAsError')
+		? config.get('code.validation.jsonSchema.logMissingSchemaAsError')
+		: false;
+
+	const logMissingSchemaAsWarning = config.has('code.validation.jsonSchema.logMissingSchemaAsWarning')
+		? config.get('code.validation.jsonSchema.logMissingSchemaAsWarning')
+		: true;
+
+	let errorCounter = 0;
+	let patternCounter = 0;
+
+	// collect all schemas
+	globbySync(patternGlobs, { onlyFiles: false }).forEach((patternPath) => {
+		const schemaFilePath = `${patternPath}/schema.json`;
+
+		if (fs.existsSync(schemaFilePath)) {
+			// console.log(`Add ${schemaFilePath}`);
+			const schema = JSON.parse(fs.readFileSync(schemaFilePath, 'utf8'));
+			if (schema.$id) {
+				// ajv.addSchema(schema);
+				ajv.addMetaSchema(schema);
+			}
 		}
-		return true;
-	}
+	});
 
-	globby.sync([`${patternPath}/_data/${wildcard}.json`]).forEach((patternDataFilePath) => {
-		const patternData = JSON.parse(fs.readFileSync(patternDataFilePath, 'utf8'));
-		const schema = JSON.parse(fs.readFileSync(schemaFilePath, 'utf8'));
+	// validate pattern data
+	globbySync(patternGlobs, { onlyFiles: false }).forEach((patternPath) => {
+		const schemaFilePath = `${patternPath}/schema.json`;
+		patternCounter++;
 
-		// console.log(`validate ${schemaFilePath} with ${patternDataFilePath}`);
-		const schemaToUse = schema.$id || schema;
-		const valid = ajv.validate(schemaToUse, patternData);
-		if (!valid) {
-			errorCouter += 1;
-			console.log(`${clc.red('Error')} (${patternDataFilePath}): ${ajv.errorsText()}`);
+		if (!fs.existsSync(schemaFilePath)) {
+			if (logMissingSchemaAsError) {
+				console.log(`${clc.red('Error')} (${patternPath}): no schema file found`);
+				errorCounter++;
+				return;
+			}
+			if (logMissingSchemaAsWarning) {
+				console.log(`${clc.yellow('Warn')} (${patternPath}): no schema file found`);
+			}
+			return;
 		}
+
+		globbySync([`${patternPath}/_data/${wildcard}.json`]).forEach((dataPath) => {
+			const patternData = JSON.parse(fs.readFileSync(dataPath, 'utf8'));
+			const schema = JSON.parse(fs.readFileSync(schemaFilePath, 'utf8'));
+			const schemaToApply = schema.$id || schema;
+
+			// console.log(`validate ${schemaFilePath} with ${dataPath}`);
+			const valid = ajv.validate(schemaToApply, patternData);
+			if (!valid) {
+				errorCounter++;
+				console.log(`${clc.red('Error')} (${dataPath}): ${ajv.errorsText()}`);
+			}
+		});
 	});
-});
-
-if (errorCouter <= 0) {
-	console.log(`${clc.green('Success:')} all data from each of the ${patternCouter} patterns are valid!\n`);
-} else {
-	console.log(`${clc.red('Error:')} we detected ${errorCouter} errors in your data.\n`);
-	process.exitCode = 1;
-}
+
+	// summary
+	if (errorCounter === 0) {
+		console.log(`${clc.green('Success:')} all data from each of the ${patternCounter} patterns are valid!\n`);
+	} else {
+		console.log(`${clc.red('Error:')} we detected ${errorCounter} errors in your data.\n`);
+		process.exitCode = 1;
+	}
+
+})();

package/app/templating/hbs/helpers/pattern.js

@@ -19,13 +19,18 @@ const fs = require('fs');
 const hbs = require('hbs');
 const path = require('path');
 const extend = require('extend');
-const globby = require('globby');
 const Ajv = require('ajv');
 const ajv = new Ajv({ allErrors: true });
 const config = require('config');
 const hbsUtils = require('../utils');
 const lint = require('../../../lib/lint');
 
+let globbySync;
+(async () => {
+	const globbyMod = await import('globby');
+	globbySync = globbyMod.globbySync;
+})();
+
 function getPatternBasePaths(type) {
 	let patternTypeKeys;
 
@@ -96,7 +101,7 @@ function getPattern(folder, templateFile, dataFile, type) {
 			return `${patternBasePath}/*/elements/${folder}/${templateFile}.${config.get('nitro.viewFileExtension')}`;
 		});
 
-		globby.sync(elementGlobs).forEach((templatePath) => {
+		globbySync(elementGlobs).forEach((templatePath) => {
 			if (!pattern) {
 				pattern = {
 					templateFilePath: templatePath,

package/app/templating/twig/helpers/component.js

@@ -11,13 +11,18 @@
 const fs = require('fs');
 const path = require('path');
 const extend = require('extend');
-const globby = require('globby');
 const Ajv = require('ajv');
 const ajv = new Ajv({ allErrors: true });
 const config = require('config');
 const twigUtils = require('../utils');
 const lint = require('../../../lib/lint');
 
+let globbySync;
+(async () => {
+	const globbyMod = await import('globby');
+	globbySync = globbyMod.globbySync;
+})();
+
 const patternBasePaths = Object.keys(config.get('nitro.patterns')).map((key) => {
 	const configKey = `nitro.patterns.${key}.path`;
 	const patternPath = config.has(configKey) ? config.get(configKey) : false;
@@ -71,7 +76,7 @@ function getPattern(folder, templateFile, dataFile) {
 			return `${patternBasePath}/*/elements/${folder}/${templateFile}.${config.get('nitro.viewFileExtension')}`;
 		});
 
-		globby.sync(elementGlobs).forEach((templatePath) => {
+		globbySync(elementGlobs).forEach((templatePath) => {
 			if (pattern) {
 				throw new Error(`You have multiple elements defined with the name \`${folder}\``);
 			} else {

package/app/templating/twig/helpers/pattern.js

@@ -11,13 +11,18 @@
 const fs = require('fs');
 const path = require('path');
 const extend = require('extend');
-const globby = require('globby');
 const Ajv = require('ajv');
 const ajv = new Ajv({ allErrors: true });
 const config = require('config');
 const twigUtils = require('../utils');
 const lint = require('../../../lib/lint');
 
+let globbySync;
+(async () => {
+	const globbyMod = await import('globby');
+	globbySync = globbyMod.globbySync;
+})();
+
 const patternBasePaths = Object.keys(config.get('nitro.patterns')).map((key) => {
 	const configKey = `nitro.patterns.${key}.path`;
 	const patternPath = config.has(configKey) ? config.get(configKey) : false;
@@ -71,7 +76,7 @@ function getPattern(folder, templateFile, dataFile) {
 			return `${patternBasePath}/*/elements/${folder}/${templateFile}.${config.get('nitro.viewFileExtension')}`;
 		});
 
-		globby.sync(elementGlobs).forEach((templatePath) => {
+		globbySync(elementGlobs).forEach((templatePath) => {
 			if (pattern) {
 				throw new Error(`You have multiple elements defined with the name \`${folder}\``);
 			} else {

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": "10.0.4",
+  "version": "11.0.0-beta.2",
   "description": "Nitro server",
   "license": "MIT",
   "repository": {
@@ -9,8 +9,8 @@
   },
   "author": "The Nitro Team",
   "engines": {
-    "node": ">=20.18.1 <21",
-    "npm": ">=10.8.2 <11"
+    "node": ">=22.11.0 <25",
+    "npm": ">=10.9.0 <12"
   },
   "bin": {
     "nitro-app-validate-pattern-data": "bin/validate-pattern-data.js",
@@ -37,30 +37,33 @@
     "cli-color": "2.0.4",
     "compression": "1.8.1",
     "cookie-session": "2.1.1",
-    "config": "4.2.0",
+    "config": "4.2.1",
     "dot-object": "2.1.5",
     "express": "4.22.1",
     "extend": "3.0.2",
-    "globby": "11.1.0",
+    "globby": "16.1.0",
     "hbs": "4.2.0",
     "hbs-utils": "0.0.4",
     "html-validate": "7.18.1",
-    "i18next": "25.8.0",
+    "i18next": "25.8.6",
     "i18next-http-middleware": "3.9.2",
     "i18next-fs-backend": "2.6.1",
     "i18next-sprintf-postprocessor": "0.2.2",
-    "jasmine": "5.13.0",
-    "jasmine-core": "5.13.0",
+    "jasmine": "6.0.0",
     "lodash": "4.17.23",
+    "open": "11.0.0",
     "twig": "1.13.3",
-    "webpack": "4.47.0",
-    "webpack-dev-middleware": "5.3.4",
+    "webpack-dev-middleware": "7.4.5",
     "webpack-hot-middleware": "2.26.1"
   },
+  "peerDependencies": {
+    "webpack": "^5"
+  },
   "devDependencies": {
     "@merkle-open/eslint-config": "4.0.1",
     "eslint": "8.57.1",
-    "eslint-plugin-import": "2.32.0"
+    "eslint-plugin-import": "2.32.0",
+    "webpack": "5.105.2"
   },
   "publishConfig": {
     "access": "public"