@ui5/cli 3.1.2 → 3.2.0

package/CHANGELOG.md

@@ -2,7 +2,27 @@
 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.1.2...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-cli/compare/v3.2.0...HEAD).
+
+<a name="v3.2.0"></a>
+## [v3.2.0] - 2023-06-06
+### Dependency Updates
+- Bump [@ui5](https://github.com/ui5)/project from 3.3.1 to 3.3.2 [`a508e96`](https://github.com/SAP/ui5-cli/commit/a508e966fb15de82c64754171fbd2202af3128e3)
+- Bump [@ui5](https://github.com/ui5)/server from 3.1.2 to 3.1.3 [`888fc0c`](https://github.com/SAP/ui5-cli/commit/888fc0cf918994cab1e3c84beac757e609a61566)
+- Bump [@ui5](https://github.com/ui5)/builder from 3.0.4 to 3.0.5 [`1155cfc`](https://github.com/SAP/ui5-cli/commit/1155cfccb57f7d588063999719d1a0814fd7e939)
+
+### Features
+- **SNAPSHOT Consumption:** Add cache-mode parameter ([#633](https://github.com/SAP/ui5-cli/issues/633)) [`61d0865`](https://github.com/SAP/ui5-cli/commit/61d0865416eaee9bfc08195f636c60ad4f64e13f)
+- **ui5 tree:** Add 'level' and 'flat' parameters ([#635](https://github.com/SAP/ui5-cli/issues/635)) [`284d9ea`](https://github.com/SAP/ui5-cli/commit/284d9ea9f75967257859b7763e7b9a09a3b219cf)
+
+
+<a name="v3.1.3"></a>
+## [v3.1.3] - 2023-05-23
+### Dependency Updates
+- Bump [@ui5](https://github.com/ui5)/project from 3.3.0 to 3.3.1 [`dbe7657`](https://github.com/SAP/ui5-cli/commit/dbe765789c2998e71dbc2acfe18029400c144159)
+- Bump [@ui5](https://github.com/ui5)/builder from 3.0.3 to 3.0.4 [`44a7b21`](https://github.com/SAP/ui5-cli/commit/44a7b21618fe2892d6f99d5e97779a43cda24b8d)
+- Bump [@ui5](https://github.com/ui5)/fs from 3.0.3 to 3.0.4 [`9ed9ce2`](https://github.com/SAP/ui5-cli/commit/9ed9ce206ac22dbe396d10a9ae5f8ff1345c28be)
+
 
 <a name="v3.1.2"></a>
 ## [v3.1.2] - 2023-05-05
@@ -1031,6 +1051,8 @@ Only Node.js v10 or higher is supported.
 
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
+[v3.2.0]: https://github.com/SAP/ui5-cli/compare/v3.1.3...v3.2.0
+[v3.1.3]: https://github.com/SAP/ui5-cli/compare/v3.1.2...v3.1.3
 [v3.1.2]: https://github.com/SAP/ui5-cli/compare/v3.1.1...v3.1.2
 [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

package/lib/cli/base.js

@@ -52,7 +52,7 @@ export default function(cli) {
 			"config", "dependency-definition", "workspace-config", "workspace", "log-level",
 
 			// tree.js, build.js & serve.js
-			"framework-version",
+			"framework-version", "cache-mode",
 
 			// build.js
 			"dest",

package/lib/cli/commands/build.js

@@ -101,6 +101,15 @@ build.builder = function(cli) {
 			describe: "Overrides the framework version defined by the project",
 			type: "string"
 		})
+		.option("cache-mode", {
+			describe:
+				"Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+				"The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+				"does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+			type: "string",
+			default: "Default",
+			choices: ["Default", "Force", "Off"]
+		})
 		.option("experimental-css-variables", {
 			describe:
 				"Generate CSS variables (css-variables.css, css-variables.source.less)" +
@@ -129,12 +138,14 @@ async function handleBuild(argv) {
 		graph = await graphFromStaticFile({
 			filePath: argv.dependencyDefinition,
 			rootConfigPath: argv.config,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 		});
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
 			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 			workspaceConfigPath: argv.workspaceConfig,
 			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});

package/lib/cli/commands/serve.js

@@ -65,11 +65,20 @@ serve.builder = function(cli) {
 			describe: "Overrides the framework version defined by the project",
 			type: "string"
 		})
+		.option("cache-mode", {
+			describe:
+				"Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+				"The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+				"does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+			type: "string",
+			default: "Default",
+			choices: ["Default", "Force", "Off"]
+		})
 		.example("ui5 serve", "Start a web server for the current project")
 		.example("ui5 serve --h2", "Enable the HTTP/2 protocol for the web server (requires SSL certificate)")
 		.example("ui5 serve --config /path/to/ui5.yaml", "Use the project configuration from a custom path")
-		.example("ui5 serve --translator static:/path/to/projectDependencies.yaml",
-			"Use a \"static\" translator with translator parameters.")
+		.example("ui5 serve --dependency-definition /path/to/projectDependencies.yaml",
+			"Use a static dependency definition file")
 		.example("ui5 serve --port 1337 --open tests/QUnit.html",
 			"Listen to port 1337 and launch default browser with http://localhost:1337/test/QUnit.html");
 };
@@ -83,12 +92,14 @@ serve.handler = async function(argv) {
 	if (argv.dependencyDefinition) {
 		graph = await graphFromStaticFile({
 			filePath: argv.dependencyDefinition,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 		});
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
 			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 			workspaceConfigPath: argv.workspaceConfig,
 			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});

package/lib/cli/commands/tree.js

@@ -4,6 +4,7 @@ import chalk from "chalk";
 
 const tree = {
 	command: "tree",
+	aliases: ["ls", "list"],
 	describe:
 		"Outputs the dependency tree of the current project to stdout. " +
 		"It takes all relevant parameters of ui5 build into account.",
@@ -12,10 +13,28 @@ const tree = {
 
 tree.builder = function(cli) {
 	return cli
+		.option("flat", {
+			describe: "Output a flat list of all dependencies instead of a tree hierarchy",
+			type: "boolean",
+			default: false
+		})
+		.option("level", {
+			describe: "Limit the number of levels shown in the tree hierarchy",
+			type: "number"
+		})
 		.option("framework-version", {
 			describe:
 				"Overrides the framework version defined by the project",
 			type: "string"
+		})
+		.option("cache-mode", {
+			describe:
+				"Cache mode to use when consuming SNAPSHOT versions of a framework: 'Default', 'Force', or 'Off'. " +
+				"The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and " +
+				"does not create any requests. 'Off' invalidates any existing cache and updates from the repository",
+			type: "string",
+			default: "Default",
+			choices: ["Default", "Force", "Off"]
 		});
 };
 
@@ -30,12 +49,14 @@ tree.handler = async function(argv) {
 	if (argv.dependencyDefinition) {
 		graph = await graphFromStaticFile({
 			filePath: argv.dependencyDefinition,
-			versionOverride: argv.frameworkVersion
+			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 		});
 	} else {
 		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
 			versionOverride: argv.frameworkVersion,
+			cacheMode: argv.cacheMode,
 			workspaceConfigPath: argv.workspaceConfig,
 			workspaceName: argv.workspace === false ? null : argv.workspace,
 		});
@@ -45,18 +66,31 @@ tree.handler = async function(argv) {
 		elapsedTime = await getElapsedTime(startTime);
 	}
 
-	const projects = Object.create(null);
+	let requestedLevels;
+	if (argv.level !== undefined && isNaN(argv.level)) {
+		throw new Error(`The provided 'level' option is not a number`);
+	} else if (argv.level !== undefined) {
+		requestedLevels = argv.level;
+	} else {
+		requestedLevels = Infinity;
+	}
+
+	const projects = new Map();
 	const indentWidth = 4;
 	await graph.traverseBreadthFirst(async ({project, dependencies}) => {
-		projects[project.getName()] = {
-			render: function(indentation, connectorIndices, lastChild) {
-				let baseString = " ".repeat(indentation * indentWidth);
+		projects.set(project.getName(), {
+			render: function(level, connectorIndices, lastChild, renderDeps = true) {
+				let baseString = " ".repeat(level * indentWidth);
 				connectorIndices.forEach((idx) => {
 					baseString = `${baseString.slice(0, idx)}│${baseString.slice(idx + 1)}`;
 				});
 				const connectorString = lastChild ? "╰─" : "├─";
+				let name = chalk.bold(project.getName());
+				if (project.isFrameworkProject()) {
+					name = chalk.blue(name);
+				}
 				console.log(
-					`${baseString}${connectorString} ${chalk.bold(project.getName())} ` +
+					`${baseString}${connectorString} ${name} ` +
 					`${project.getNamespace() ? chalk.inverse(project.getNamespace()) + " " : ""}` +
 					chalk.dim(`(${project.getVersion()}, ${project.getType()}) `) +
 					chalk.dim.italic(`${project.getRootPath()}`)
@@ -65,18 +99,39 @@ tree.handler = async function(argv) {
 				const lastIdx = dependencies.length - 1;
 				const newConnectorIndices = [...connectorIndices];
 				if (!lastChild) {
-					newConnectorIndices.push(indentation * indentWidth);
+					newConnectorIndices.push(level * indentWidth);
+				}
+
+				if (level >= requestedLevels) {
+					const msg = chalk.dim.italic(`Dependencies below Level ${level} are hidden`);
+					let nextBaseString = " ".repeat((level + 1) * indentWidth);
+					newConnectorIndices.forEach((idx) => {
+						nextBaseString = `${nextBaseString.slice(0, idx)}│${nextBaseString.slice(idx + 1)}`;
+					});
+					console.log(`${nextBaseString}╰─ ${msg}`);
+					return;
+				}
+				if (renderDeps) {
+					dependencies.forEach((dep, i) => {
+						projects.get(dep).render(level + 1, newConnectorIndices, i === lastIdx);
+					});
 				}
-				dependencies.forEach((dep, i) => {
-					projects[dep].render(indentation + 1, newConnectorIndices, i === lastIdx);
-				});
 			}
-		};
+		});
 	});
 
-	const projectKeys = Object.keys(projects);
-	console.log(chalk.bold.underline(`Dependencies (${projectKeys.length}):`));
-	projects[projectKeys[0]].render(0, [], true);
+	console.log(chalk.bold.underline(`Dependencies (${projects.size}):`));
+	if (argv.flat) {
+		// Iterate over list of projects, rendering each individually
+		// We need to transform the map into an array in order to know the index
+		// for determining whether we are rendering the last entry (lastChild param)
+		Array.from(projects.values()).forEach(({render: renderProject}, idx, arr) => {
+			renderProject(0, [], idx == arr.length -1, false);
+		});
+	} else {
+		// Recursively render the tree, starting with the first entry of the map
+		projects.values().next().value.render(0, [], true);
+	}
 	console.log("");
 
 	const extensionNames = graph.getExtensionNames();