@ui5/cli 3.0.7 → 3.1.1

package/CHANGELOG.md

@@ -2,7 +2,25 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-cli/compare/v3.0.7...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-cli/compare/v3.1.1...HEAD).
+
+<a name="v3.1.1"></a>
+## [v3.1.1] - 2023-04-27
+### Dependency Updates
+- Bump [@ui5](https://github.com/ui5)/project from 3.2.1 to 3.2.2 [`defb631`](https://github.com/SAP/ui5-cli/commit/defb6313fc651826876dd9713ee67fba72ced51c)
+
+
+<a name="v3.1.0"></a>
+## [v3.1.0] - 2023-04-26
+### Dependency Updates
+- Bump [@ui5](https://github.com/ui5)/project from 3.2.0 to 3.2.1 [`922fb09`](https://github.com/SAP/ui5-cli/commit/922fb09c9cb6b8f317b8bba55a9a13f152532c73)
+- Bump [@ui5](https://github.com/ui5)/project from 3.1.1 to 3.2.0 [`4619e2f`](https://github.com/SAP/ui5-cli/commit/4619e2fc555987613920a4a30808534cbd70ab79)
+- Bump [@ui5](https://github.com/ui5)/builder from 3.0.2 to 3.0.3 [`b5fbf4a`](https://github.com/SAP/ui5-cli/commit/b5fbf4adb094ab534d893d0f1e1f45226c52149b)
+- Bump [@ui5](https://github.com/ui5)/fs from 3.0.2 to 3.0.3 [`c6fd1f8`](https://github.com/SAP/ui5-cli/commit/c6fd1f8c6c4c0d1419cb5820d6d37e173f528d1d)
+
+### Features
+- Add config command ([#618](https://github.com/SAP/ui5-cli/issues/618)) [`9910e30`](https://github.com/SAP/ui5-cli/commit/9910e304b80ca262587e99ab9a6118a4db15c584)
+
 
 <a name="v3.0.7"></a>
 ## [v3.0.7] - 2023-04-12
@@ -1007,6 +1025,8 @@ Only Node.js v10 or higher is supported.
 
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
+[v3.1.1]: https://github.com/SAP/ui5-cli/compare/v3.1.0...v3.1.1
+[v3.1.0]: https://github.com/SAP/ui5-cli/compare/v3.0.7...v3.1.0
 [v3.0.7]: https://github.com/SAP/ui5-cli/compare/v3.0.6...v3.0.7
 [v3.0.6]: https://github.com/SAP/ui5-cli/compare/v3.0.5...v3.0.6
 [v3.0.5]: https://github.com/SAP/ui5-cli/compare/v3.0.4...v3.0.5

package/lib/cli/base.js

@@ -4,7 +4,7 @@ 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.")
+		.demandCommand(1, "Command required")
 		.option("config", {
 			alias: "c",
 			describe: "Path to project configuration file in YAML format",
@@ -121,7 +121,7 @@ export default function(cli) {
 				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`));
+				console.log(chalk.dim(`See 'ui5 --help'`));
 			}
 			process.exit(1);
 		});

package/lib/cli/commands/config.js

@@ -0,0 +1,88 @@
+import chalk from "chalk";
+import process from "node:process";
+import baseMiddleware from "../middlewares/base.js";
+
+const configCommand = {
+	command: "config",
+	describe: "Get and set UI5 Tooling configuration options",
+	middlewares: [baseMiddleware],
+	handler: handleConfig
+};
+
+configCommand.builder = function(cli) {
+	return cli
+		.demandCommand(1, "Command required. Available commands are 'set', 'get', and 'list'")
+		.command("set <key> [value]", "Set the value for a given configuration key. " +
+			"Clear an existing configuration by omitting the value", {
+			handler: handleConfig,
+			builder: noop,
+			middlewares: [baseMiddleware],
+		})
+		.command("get <key>", "Get the value for a given configuration key", {
+			handler: handleConfig,
+			builder: noop,
+			middlewares: [baseMiddleware],
+		})
+		.command("list", "Display the current configuration", {
+			handler: handleConfig,
+			builder: noop,
+			middlewares: [baseMiddleware],
+		})
+		.example("$0 set mavenSnapshotEndpointUrl http://example.com/snapshots/",
+			"Set a value for the mavenSnapshotEndpointUrl configuration")
+		.example("$0 set mavenSnapshotEndpointUrl",
+			"Unset the current value of the mavenSnapshotEndpointUrl configuration");
+};
+
+function noop() {}
+
+async function handleConfig(argv) {
+	const {_: commandArgs, key, value} = argv;
+	const command = commandArgs[commandArgs.length - 1];
+
+	const {default: Configuration} = await import( "@ui5/project/config/Configuration");
+	const allowedKeys = ["mavenSnapshotEndpointUrl"];
+
+	if (["set", "get"].includes(command) && !allowedKeys.includes(key)) {
+		throw new Error(
+			`The provided key is not a valid configuration option. Valid options are: ${allowedKeys.join(", ")}`);
+	}
+
+	const config = await Configuration.fromFile();
+	if (command === "list") {
+		// Print all configuration values to stdout
+		process.stdout.write(formatJsonForOutput(config.toJson()));
+	} else if (command === "get") {
+		// Get a single configuration value and print to stdout
+		let configValue = config.toJson()[key];
+		if (configValue === undefined) {
+			configValue = "";
+		}
+		process.stdout.write(`${configValue}\n`);
+	} else if (command === "set") {
+		const jsonConfig = config.toJson();
+		if (value === undefined || value === "") {
+			delete jsonConfig[key];
+			process.stderr.write(`Configuration option ${chalk.bold(key)} has been unset\n`);
+		} else {
+			jsonConfig[key] = value;
+			process.stderr.write(`Configuration option ${chalk.bold(key)} has been updated:
+${formatJsonForOutput(jsonConfig, key)}`);
+		}
+
+		await Configuration.toFile(new Configuration(jsonConfig));
+	} else {
+		throw new Error(`Unknown 'ui5 config' command '${command}'`);
+	}
+}
+
+function formatJsonForOutput(config, filterKey) {
+	return Object.keys(config)
+		.filter((key) => !filterKey || filterKey === key)
+		.filter((key) => config[key] !== undefined) // Don't print undefined config values
+		.map((key) => {
+			return `  ${key} = ${config[key]}\n`;
+		}).join("");
+}
+
+export default configCommand;

package/lib/framework/add.js

@@ -17,24 +17,27 @@ export default async function({projectGraphOptions, libraries}) {
 		);
 	}
 
-	if (!project.getFrameworkName()) {
+	const frameworkName = project.getFrameworkName();
+	const frameworkVersion = project.getFrameworkVersion();
+
+	if (!frameworkName) {
 		throw new Error(
 			`Project ${project.getName()} is missing a framework configuration. ` +
 			`Please use "ui5 use" to configure a framework and version.`
 		);
 	}
-	if (!project.getFrameworkVersion()) {
+	if (!frameworkVersion) {
 		throw new Error(
 			`Project ${project.getName()} does not define a framework version configuration. ` +
 			`Please use "ui5 use" to configure a version.`
 		);
 	}
 
-	const Resolver = getFrameworkResolver(project.getFrameworkName());
+	const Resolver = await getFrameworkResolver(frameworkName, frameworkVersion);
 
 	const resolver = new Resolver({
 		cwd: project.getRootPath(),
-		version: project.getFrameworkVersion()
+		version: frameworkVersion
 	});
 
 	// Get metadata of all libraries to verify that they can be installed
@@ -42,7 +45,7 @@ export default async function({projectGraphOptions, libraries}) {
 		try {
 			await resolver.getLibraryMetadata(name);
 		} catch (err) {
-			throw new Error(`Failed to find ${project.getFrameworkName()} framework library ${name}: ` + err.message);
+			throw new Error(`Failed to find ${frameworkName} framework library ${name}: ` + err.message);
 		}
 	}));
 

package/lib/framework/use.js

@@ -1,7 +1,8 @@
 import {getRootProjectConfiguration, getFrameworkResolver} from "./utils.js";
 
 async function resolveVersion({frameworkName, frameworkVersion}, resolverOptions) {
-	return await getFrameworkResolver(frameworkName).resolveVersion(frameworkVersion, resolverOptions);
+	const Resolver = await getFrameworkResolver(frameworkName, frameworkVersion);
+	return Resolver.resolveVersion(frameworkVersion, resolverOptions);
 }
 
 function getEffectiveFrameworkName({project, frameworkOptions}) {

package/lib/framework/utils.js

@@ -1,6 +1,4 @@
 import {graphFromStaticFile, graphFromPackageDependencies} from "@ui5/project/graph";
-import Sapui5Resolver from "@ui5/project/ui5Framework/Sapui5Resolver";
-import Openui5Resolver from "@ui5/project/ui5Framework/Openui5Resolver";
 
 export async function getRootProjectConfiguration(projectGraphOptions) {
 	let graph;
@@ -19,11 +17,14 @@ export async function getRootProjectConfiguration(projectGraphOptions) {
 	return graph.getRoot();
 }
 
-export function getFrameworkResolver(frameworkName) {
-	if (frameworkName === "SAPUI5") {
-		return Sapui5Resolver;
+export async function getFrameworkResolver(frameworkName, frameworkVersion) {
+	if (frameworkVersion.toLowerCase().endsWith("-snapshot")) {
+		// Framework version could be for example: "latest-snapshot" or "1.112.0-SNAPSHOT"
+		return (await import("@ui5/project/ui5Framework/Sapui5MavenSnapshotResolver")).default;
 	} else if (frameworkName === "OpenUI5") {
-		return Openui5Resolver;
+		return (await import("@ui5/project/ui5Framework/Openui5Resolver")).default;
+	} else if (frameworkName === "SAPUI5") {
+		return (await import("@ui5/project/ui5Framework/Sapui5Resolver")).default;
 	} else {
 		throw new Error("Invalid framework.name: " + frameworkName);
 	}