@ui5/cli 3.0.0-alpha.9 → 3.0.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/cli",
-	"version": "3.0.0-alpha.9",
+	"version": "3.0.0-beta.2",
 	"description": "UI5 Tooling - CLI",
 	"author": {
 		"name": "SAP SE",
@@ -17,11 +17,16 @@
 		"tool"
 	],
 	"bin": {
-		"ui5": "./bin/ui5.js"
+		"ui5": "./bin/ui5.cjs"
+	},
+	"type": "module",
+	"exports": {
+		"./bin/ui5.js": "./bin/ui5.cjs",
+		"./bin/ui5.cjs": "./bin/ui5.cjs",
+		"./package.json": "./package.json"
 	},
-	"main": "index.js",
 	"engines": {
-		"node": ">= 16.13.2",
+		"node": "^16.18.0 || >=18.0.0",
 		"npm": ">= 8"
 	},
 	"scripts": {
@@ -30,11 +35,11 @@
 		"lint": "eslint ./",
 		"unit": "rimraf test/tmp && ava",
 		"unit-verbose": "rimraf test/tmp && cross-env UI5_LOG_LVL=verbose ava --verbose --serial",
-		"unit-watch": "rimraf test/tmp && ava --watch",
-		"unit-nyan": "rimraf test/tmp && ava --tap | tnyan",
-		"unit-xunit": "rimraf test/tmp && ava --tap | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
+		"unit-watch": "npm run unit -- --watch",
+		"unit-nyan": "npm run unit -- --tap | tnyan",
+		"unit-xunit": "rimraf test/tmp && ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\" --tap | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
 		"unit-inspect": "cross-env UI5_LOG_LVL=verbose ava debug --break",
-		"coverage": "nyc npm run unit",
+		"coverage": "rimraf test/tmp && nyc ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\"",
 		"coverage-xunit": "nyc --reporter=text --reporter=text-summary --reporter=cobertura npm run unit-xunit",
 		"jsdoc": "npm run jsdoc-generate && open-cli jsdocs/index.html",
 		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
@@ -43,12 +48,11 @@
 		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
 		"prepublishOnly": "git push --follow-tags",
 		"release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version | node .chglog/consolidate-changelogs.js",
-		"depcheck": "depcheck --ignores docdash,@ui5/fs,@ui5/builder"
+		"depcheck": "depcheck --ignores @ui5/cli,docdash,@istanbuljs/esm-loader-hook,@ui5/fs,@ui5/builder"
 	},
 	"files": [
 		"CHANGELOG.md",
 		"CONTRIBUTING.md",
-		"index.js",
 		"jsdoc.json",
 		"npm-shrinkwrap.json",
 		"bin/**",
@@ -60,6 +64,10 @@
 		"files": [
 			"test/bin/**/*.js",
 			"test/lib/**/*.js"
+		],
+		"nodeArguments": [
+			"--loader=esmock",
+			"--no-warnings"
 		]
 	},
 	"nyc": {
@@ -74,8 +82,8 @@
 			"jsdocs/**",
 			"coverage/**",
 			"test/**",
-			".eslintrc.js",
-			"jsdoc-plugin.js"
+			".eslintrc.cjs",
+			"jsdoc-plugin.cjs"
 		],
 		"check-coverage": true,
 		"statements": 80,
@@ -108,37 +116,39 @@
 		"url": "git@github.com:SAP/ui5-cli.git"
 	},
 	"dependencies": {
-		"@ui5/builder": "^3.0.0-alpha.8",
-		"@ui5/fs": "^3.0.0-alpha.5",
-		"@ui5/logger": "^3.0.1-alpha.1",
-		"@ui5/project": "^3.0.0-alpha.4",
-		"@ui5/server": "^3.0.0-alpha.2",
-		"chalk": "^4.1.2",
+		"@ui5/builder": "^3.0.0-beta.2",
+		"@ui5/fs": "^3.0.0-beta.3",
+		"@ui5/logger": "^3.0.1-beta.1",
+		"@ui5/project": "^3.0.0-beta.3",
+		"@ui5/server": "^3.0.0-beta.2",
+		"chalk": "^5.1.2",
 		"data-with-position": "^0.5.0",
 		"import-local": "^3.1.0",
 		"js-yaml": "^4.1.0",
-		"open": "^7.4.2",
+		"open": "^8.4.0",
 		"pretty-hrtime": "^1.0.3",
-		"semver": "^7.3.5",
-		"update-notifier": "^5.1.0",
-		"yargs": "^16.2.0"
+		"semver": "^7.3.8",
+		"update-notifier": "^6.0.2",
+		"yargs": "^17.6.2"
 	},
 	"devDependencies": {
-		"ava": "^3.15.0",
+		"@istanbuljs/esm-loader-hook": "^0.2.0",
+		"ava": "^5.1.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
-		"docdash": "^1.2.0",
-		"eslint": "^8.7.0",
+		"docdash": "^2.0.0",
+		"eslint": "^8.28.0",
 		"eslint-config-google": "^0.14.0",
-		"eslint-plugin-jsdoc": "^37.6.3",
+		"eslint-plugin-ava": "^13.2.0",
+		"eslint-plugin-jsdoc": "^39.6.4",
+		"esmock": "^2.0.9",
 		"execa": "^5.1.1",
-		"jsdoc": "^3.6.7",
-		"mock-require": "^3.0.3",
+		"jsdoc": "^3.6.11",
 		"nyc": "^15.1.0",
-		"open-cli": "^6.0.1",
+		"open-cli": "^7.1.0",
 		"rimraf": "^3.0.2",
-		"sinon": "^11.1.2",
+		"sinon": "^14.0.2",
 		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"
 	}

package/bin/ui5.js

@@ -1,98 +0,0 @@
-#!/usr/bin/env node
-
-// The following block should be compatible to as many Node.js versions as possible
-/* eslint-disable no-var */
-var pkg = require("../package.json");
-var semver;
-try {
-	semver = require("semver");
-} catch (err) {
-	// SyntaxError indicates an outdated Node.js version
-	if (err.name !== "SyntaxError") {
-		throw err;
-	}
-}
-var nodeVersion = process.version;
-/* eslint-enable no-var */
-if (
-	pkg.engines && pkg.engines.node &&
-	(!semver || !semver.satisfies(nodeVersion, pkg.engines.node, {includePrerelease: true}))
-) {
-	console.log("==================== UNSUPPORTED NODE.JS VERSION ====================");
-	console.log("You are using an unsupported version of Node.js");
-	console.log("Detected version " + nodeVersion + " but " + pkg.name + " requires " + pkg.engines.node);
-	console.log("");
-	console.log("=> Please upgrade to a supported version of Node.js to use this tool");
-	console.log("=====================================================================");
-	process.exit(1);
-} else {
-	if (semver && semver.prerelease(nodeVersion)) {
-		console.log("====================== UNSTABLE NODE.JS VERSION =====================");
-		console.log("You are using an unstable version of Node.js");
-		console.log("Detected Node.js version " + nodeVersion);
-		console.log("");
-		console.log("=> Please note that an unstable version might cause unexpected");
-		console.log("   behavior. For productive use please consider using a stable");
-		console.log("   version of Node.js! For the release policy of Node.js, see");
-		console.log("   https://nodejs.org/en/about/releases");
-		console.log("=====================================================================");
-	}
-	// Timeout is required to log info when importing from local installation
-	setTimeout(() => {
-		if (!process.env.UI5_CLI_NO_LOCAL) {
-			const importLocal = require("import-local");
-			// Prefer a local installation of @ui5/cli.
-			// This will invoke the local CLI, so no further action required
-			if (importLocal(__filename)) {
-				if (process.argv.includes("--verbose")) {
-					console.info(`INFO: This project contains an individual ${pkg.name} installation which ` +
-					"will be used over the global one.");
-					console.info("See https://github.com/SAP/ui5-cli#local-vs-global-installation for details.");
-					console.info("");
-				} else {
-					console.info(`INFO: Using local ${pkg.name} installation`);
-					console.info("");
-				}
-				return;
-			}
-		}
-
-		const updateNotifier = require("update-notifier");
-		updateNotifier({
-			pkg,
-			updateCheckInterval: 1000 * 60 * 60 * 24, // 1 day
-			shouldNotifyInNpmScript: true
-		}).notify();
-		// Remove --no-update-notifier from argv as it's not known to yargs, but we still want to support using it
-		const NO_UPDATE_NOTIFIER = "--no-update-notifier";
-		if (process.argv.includes(NO_UPDATE_NOTIFIER)) {
-			process.argv = process.argv.filter((v) => v !== NO_UPDATE_NOTIFIER);
-		}
-
-		const cli = require("yargs");
-
-		cli.parserConfiguration({
-			"parse-numbers": false
-		});
-
-		// Explicitly set CLI version as the yargs default might
-		// be wrong in case a local CLI installation is used
-		// Also add CLI location
-		const version = `${pkg.version} (from ${__filename})`;
-		require("../lib/cli/version").set(version);
-		cli.version(version);
-
-		// Explicitly set script name to prevent windows from displaying "ui5.js"
-		cli.scriptName("ui5");
-
-		// CLI modules
-		cli.commandDir("../lib/cli/commands");
-
-		// Format terminal output to full available width
-		cli.wrap(cli.terminalWidth());
-
-		// yargs registers a get method on the argv property.
-		// The property needs to be accessed to initialize everything.
-		cli.argv;
-	}, 0);
-}

package/index.js

@@ -1,7 +0,0 @@
-/**
- * @module @ui5/cli
- * @private
- */
-module.exports = {
-	init: require("./lib/init/init").init
-};

package/lib/cli/commands/base.js

@@ -1,76 +0,0 @@
-const cli = require("yargs");
-
-cli.usage("Usage: ui5 <command> [options]")
-	.demandCommand(1, "Command required! Please have a look at the help documentation above.")
-	.option("config", {
-		describe: "Path to project configuration file in YAML format",
-		type: "string"
-	})
-	.option("dependency-definition", {
-		describe: "Path to a YAML file containing the project's dependency tree. " +
-			"This option will disable resolution of node package dependencies.",
-		type: "string"
-	})
-	.option("verbose", {
-		describe: "Enable verbose logging.",
-		type: "boolean"
-	})
-	.option("loglevel", {
-		alias: "log-level",
-		describe: "Set the logging level (error|warn|info|verbose|silly).",
-		default: "info",
-		type: "string"
-	})
-	.option("x-perf", {
-		describe: "Outputs performance measurements",
-		default: false,
-		type: "boolean"
-	})
-	.showHelpOnFail(true)
-	.strict(true)
-	.alias("help", "h")
-	.alias("version", "v")
-	.example("ui5 <command> --translator static:/path/to/projectDependencies.yaml",
-		"Execute command using a \"static\" translator with translator parameters")
-	.example("ui5 <command> --config /path/to/ui5.yaml",
-		"Execute command using a project configuration from custom path")
-	.fail(function(msg, err, yargs) {
-		const chalk = require("chalk");
-		if (err) {
-			// Exception
-			const logger = require("@ui5/logger");
-			if (logger.isLevelEnabled("error")) {
-				console.log("");
-				console.log(chalk.bold.red("⚠️  Process Failed With Error"));
-
-				console.log("");
-				console.log(chalk.underline("Error Message:"));
-				console.log(err.message);
-
-				// Unexpected errors should always be logged with stack trace
-				const unexpectedErrors = ["SyntaxError", "ReferenceError", "TypeError"];
-				if (unexpectedErrors.includes(err.name) || logger.isLevelEnabled("verbose")) {
-					console.log("");
-					console.log(chalk.underline("Stack Trace:"));
-					console.log(err.stack);
-					console.log("");
-					console.log(
-						chalk.dim(
-							`If you think this is an issue of the UI5 Tooling, you might report it using the ` +
-							`following URL: `) +
-						chalk.dim.bold.underline(`https://github.com/SAP/ui5-tooling/issues/new/choose`));
-				} else {
-					console.log("");
-					console.log(chalk.dim(
-						`For details, execute the same command again with an additional '--verbose' parameter`));
-				}
-			}
-		} else {
-			// Yargs error
-			console.log(chalk.bold.yellow("Command Failed:"));
-			console.log(`${msg}`);
-			console.log("");
-			console.log(chalk.dim(`See 'ui5 --help' or 'ui5 build --help' for help`));
-		}
-		process.exit(1);
-	});