[INTERNAL] Yargs: If an option is provided multiple times, use the last

Before, when specifying an option like "--dest" multiple times lead to
an error. Yargs would automatically create an array, which UI5 Tooling
typically can't handle properly.

This change makes sure that any array created by yargs is transformed
back to a single string, containing the value of the option provided
last.

Author: RandomByte

lib/cli/base.js

@@ -35,6 +35,33 @@ export default function(cli) {
 			default: false,
 			type: "boolean"
 		})
+		.coerce([
+			// base.js
+			"config", "dependency-definition", "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")

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",

test/lib/cli/base.js

@@ -4,6 +4,7 @@ import {execa} from "execa";
 import sinon from "sinon";
 import esmock from "esmock";
 import chalk from "chalk";
+import stripAnsi from "strip-ansi";
 import yargs from "yargs";
 import {fileURLToPath} from "node:url";
 import {readFileSync} from "node:fs";
@@ -42,6 +43,11 @@ test.serial("ui5 -v", async (t) => {
 	t.is(stdout, `${pkg.version} (from ${ui5Cli})`);
 });
 
+test.serial("Handle multiple options", async (t) => {
+	const {stderr} = await ui5(["versions", "--log-level", "silent", "--log-level", "silly"]);
+	t.regex(stripAnsi(stderr), /^verb/, "Verbose logging got enabled");
+});
+
 test.serial("Yargs error handling", async (t) => {
 	const {consoleLogStub} = t.context;