@ui5/cli 3.0.0-rc.4 → 3.0.0

package/lib/cli/base.js

@@ -1,10 +1,12 @@
 import chalk from "chalk";
 import {isLogLevelEnabled} from "@ui5/logger";
+import ConsoleWriter from "@ui5/logger/writers/Console";
 
 export default function(cli) {
 	cli.usage("Usage: ui5 <command> [options]")
 		.demandCommand(1, "Command required! Please have a look at the help documentation above.")
 		.option("config", {
+			alias: "c",
 			describe: "Path to project configuration file in YAML format",
 			type: "string"
 		})
@@ -13,31 +15,80 @@ export default function(cli) {
 		"This option will disable resolution of node package dependencies.",
 			type: "string"
 		})
-		.option("verbose", {
-			describe: "Enable verbose logging.",
-			type: "boolean"
+		.option("workspace-config", {
+			describe: "Path to workspace configuration file in YAML format",
+			type: "string"
+		})
+		.option("workspace", {
+			alias: "w",
+			describe: "Name of the workspace configuration to use",
+			default: "default",
+			type: "string"
 		})
 		.option("loglevel", {
 			alias: "log-level",
-			describe: "Set the logging level (error|warn|info|verbose|silly).",
+			describe: "Set the logging level (silent|error|warn|info|perf|verbose|silly).",
 			default: "info",
-			type: "string"
+			type: "string",
+			choices: ["silent", "error", "warn", "info", "perf", "verbose", "silly"]
+		})
+		.option("verbose", {
+			describe: "Enable verbose logging.",
+			default: false,
+			type: "boolean"
+		})
+		.option("perf", {
+			describe: "Enable performance measurements and related logging.",
+			default: false,
+			type: "boolean"
 		})
-		.option("x-perf", {
-			describe: "Outputs performance measurements",
+		.option("silent", {
+			describe: "Disable all log output.",
 			default: false,
 			type: "boolean"
 		})
+		.coerce([
+			// base.js
+			"config", "dependency-definition", "workspace-config", "workspace", "log-level",
+
+			// tree.js, build.js & serve.js
+			"framework-version",
+
+			// build.js
+			"dest",
+
+			// serve.js
+			"open", "port", "key", "cert",
+		], (arg) => {
+			// If an option is specified multiple times, yargs creates an array for all the values,
+			// independently of whether the option is of type "array" or "string".
+			// This is unexpected for options listed above, which should all only have only one definitive value.
+			// The yargs behavior could be disabled by using the parserConfiguration "duplicate-arguments-array": true
+			// However, yargs would then cease to create arrays for those options where we *do* expect the
+			// automatic creation of arrays in case the option is specified multiple times. Like "--include-task".
+			// Also see https://github.com/yargs/yargs/issues/1318
+			// Note: This is not necessary for options of type "boolean"
+			if (Array.isArray(arg)) {
+				// If the option is specified multiple times, use the value of the last option
+				return arg[arg.length - 1];
+			}
+			return arg;
+		})
 		.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> --dependency-definition /path/to/projectDependencies.yaml",
+			"Execute command using a static dependency tree instead of resolving node package dependencies")
 		.example("ui5 <command> --config /path/to/ui5.yaml",
 			"Execute command using a project configuration from custom path")
+		.example("ui5 <command> --workspace dolphin",
+			"Execute command using the 'dolphin' workspace of a ui5-workspace.yaml")
+		.example("ui5 <command> --log-level silly",
+			"Execute command with the maximum log output")
 		.fail(function(msg, err, yargs) {
 			if (err) {
+				ConsoleWriter.stop();
 				// Exception
 				if (isLogLevelEnabled("error")) {
 					console.log("");

package/lib/cli/commands/build.js

@@ -36,33 +36,39 @@ build.builder = function(cli) {
 			describe: "A list of dependencies to be included in the build result. You can use the asterisk '*' as" +
 				" an alias for including all dependencies in the build result. The listed dependencies cannot be" +
 				" overruled by dependencies defined in 'exclude-dependency'.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("include-dependency-regexp", {
 			describe: "A list of regular expressions defining dependencies to be included in the build result." +
 				" This list is prioritized like 'include-dependency'.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("include-dependency-tree", {
 			describe: "A list of dependencies to be included in the build result. Transitive dependencies are" +
 				" implicitly included and do not need to be part of this list. These dependencies overrule" +
 				" the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("exclude-dependency", {
 			describe: "A list of dependencies to be excluded from the build result. The listed dependencies can" +
 				" be overruled by dependencies defined in 'include-dependency'.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("exclude-dependency-regexp", {
 			describe: "A list of regular expressions defining dependencies to be excluded from the build result." +
 				" This list is prioritized like 'exclude-dependency'.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("exclude-dependency-tree", {
 			describe: "A list of dependencies to be excluded from the build result. Transitive dependencies are" +
 				" implicitly included and do not need to be part of this list.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("dest", {
 			describe: "Path of build destination",
@@ -83,11 +89,13 @@ build.builder = function(cli) {
 		.option("include-task", {
 			describe: "A list of tasks to be added to the default execution set. " +
 				"This option takes precedence over any excludes.",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("exclude-task", {
 			describe: "A list of tasks to be excluded from the default task execution set",
-			type: "array"
+			type: "string",
+			array: true
 		})
 		.option("framework-version", {
 			describe: "Overrides the framework version defined by the project",
@@ -126,7 +134,9 @@ async function handleBuild(argv) {
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			workspaceConfigPath: argv.workspaceConfig,
+			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});
 	}
 	const buildSettings = graph.getRoot().getBuilderSettings() || {};

package/lib/cli/commands/serve.js

@@ -88,7 +88,9 @@ serve.handler = async function(argv) {
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			workspaceConfigPath: argv.workspaceConfig,
+			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});
 	}
 

package/lib/cli/commands/tree.js

@@ -22,7 +22,7 @@ tree.builder = function(cli) {
 tree.handler = async function(argv) {
 	let startTime;
 	let elapsedTime;
-	if (argv.xPerf) {
+	if (argv.perf) {
 		startTime = process.hrtime();
 	}
 	const {graphFromStaticFile, graphFromPackageDependencies} = await import("@ui5/project/graph");
@@ -35,11 +35,13 @@ tree.handler = async function(argv) {
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			workspaceConfigPath: argv.workspaceConfig,
+			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});
 	}
 
-	if (argv.xPerf) {
+	if (argv.perf) {
 		elapsedTime = await getElapsedTime(startTime);
 	}
 
@@ -55,9 +57,9 @@ tree.handler = async function(argv) {
 				const connectorString = lastChild ? "╰─" : "├─";
 				console.log(
 					`${baseString}${connectorString} ${chalk.bold(project.getName())} ` +
-					`${project.getNamespace ? chalk.inverse(project.getNamespace()) + " " : ""}` +
+					`${project.getNamespace() ? chalk.inverse(project.getNamespace()) + " " : ""}` +
 					chalk.dim(`(${project.getVersion()}, ${project.getType()}) `) +
-					chalk.dim.italic(`${project.getPath()}`)
+					chalk.dim.italic(`${project.getRootPath()}`)
 				);
 
 				const lastIdx = dependencies.length - 1;
@@ -88,12 +90,12 @@ tree.handler = async function(argv) {
 			console.log(
 				`${connectorString} ${extensionName} ` +
 				chalk.dim(`(${extension.getVersion()}, ${extension.getType()}) `) +
-				chalk.dim.italic(`${extension.getPath()}`));
+				chalk.dim.italic(`${extension.getRootPath()}`));
 		});
 	} else {
 		console.log(chalk.italic(`None`));
 	}
-	if (argv.xPerf) {
+	if (argv.perf) {
 		console.log("");
 		console.log(chalk.blue(
 			`Dependency graph generation took ${chalk.bold(elapsedTime)}`));

package/lib/cli/middlewares/logger.js

@@ -1,4 +1,4 @@
-import {setLogLevel, getLogger} from "@ui5/logger";
+import {setLogLevel, isLogLevelEnabled, getLogger} from "@ui5/logger";
 import ConsoleWriter from "@ui5/logger/writers/Console";
 import {getVersion} from "../version.js";
 /**
@@ -7,13 +7,25 @@ import {getVersion} from "../version.js";
  * @param {object} argv logger arguments
  */
 export async function initLogger(argv) {
-	ConsoleWriter.init();
-
-	if (argv.loglevel) {
-		setLogLevel(argv.loglevel);
+	if (argv.silent) {
+		setLogLevel("silent");
+	}
+	if (argv.perf) {
+		setLogLevel("perf");
 	}
 	if (argv.verbose) {
 		setLogLevel("verbose");
+	}
+	if (argv.loglevel && argv.loglevel !== "info") {
+		// argv.loglevel defaults to "info", which is anyways already the Logger's default
+		// Therefore do not explicitly set it again in order to allow overwriting the log level
+		// using the UI5_LOG_LVL environment variable
+		setLogLevel(argv.loglevel);
+	}
+
+	// Initialize writer
+	ConsoleWriter.init();
+	if (isLogLevelEnabled("verbose")) {
 		const log = getLogger("cli:middlewares:base");
 		log.verbose(`using @ui5/cli version ${getVersion()}`);
 		log.verbose(`using node version ${process.version}`);

package/lib/framework/add.js

@@ -33,7 +33,7 @@ export default async function({projectGraphOptions, libraries}) {
 	const Resolver = getFrameworkResolver(project.getFrameworkName());
 
 	const resolver = new Resolver({
-		cwd: project.getPath(),
+		cwd: project.getRootPath(),
 		version: project.getFrameworkVersion()
 	});
 

package/lib/framework/updateYaml.js

@@ -1,7 +1,7 @@
 import path from "node:path";
 import {readFile, writeFile} from "node:fs/promises";
 import {loadAll, dump} from "js-yaml";
-import {fromYaml, getPosition, getValue} from "data-with-position";
+import {fromYaml, getPosition, getValue, getKind} from "data-with-position";
 import {getLogger} from "@ui5/logger";
 
 const log = getLogger("cli:framework:updateYaml");
@@ -110,7 +110,23 @@ function getValueFromPath(data, path) {
 }
 
 function getPositionFromPath(positionData, path) {
-	return getPosition(getValueFromPath(positionData, path));
+	const data = getValueFromPath(positionData, path);
+	const position = getPosition(data);
+	const kind = getKind(data);
+	if ((kind === "array" && data.length) || kind === "object") {
+		// data-with-position treats arrays and objects different from primitives:
+		// The end index of such nodes always reaches up to the beginning of the following node, instead of the end
+		// of the contained data.
+		// For example, if an array has entries, the end position of the array is *directly* at the beginning of
+		// the next node instead of at the end of the last entry.
+		// Typically this means one line and multiple columns *after* the array ended.
+		// However, if an array has no entries (e.g. "[]"), the end is directly after the end of that data and
+		// *not* in the next line (this appears to be an inconsistency).
+		// Therefore, in case we encounter an array *with entries*, or an object, we reset the end column to "1"
+		// to prevent replacing (i.e. removing) the indentation of the following node.
+		position.end.column = 1;
+	}
+	return position;
 }
 
 function formatValue(value, indent) {
@@ -146,10 +162,10 @@ export default async function({project, configPathOverride, data}) {
 		if (path.isAbsolute(configPathOverride)) {
 			configPath = configPathOverride;
 		} else {
-			configPath = path.join(project.getPath(), configPathOverride);
+			configPath = path.join(project.getRootPath(), configPathOverride);
 		}
 	} else {
-		configPath = path.join(project.getPath(), "ui5.yaml");
+		configPath = path.join(project.getRootPath(), "ui5.yaml");
 	}
 
 	const configFile = await readFile(configPath, {encoding: "utf8"});

package/lib/framework/use.js

@@ -42,7 +42,7 @@ export default async function({projectGraphOptions, frameworkOptions}) {
 			frameworkName: framework.name,
 			frameworkVersion
 		}, {
-			cwd: project.getPath()
+			cwd: project.getRootPath()
 		});
 	}