@ui5/cli 3.0.0-alpha.8 → 3.0.0-beta.1

package/lib/cli/commands/tree.js

@@ -1,10 +1,13 @@
 // Tree
+import baseMiddleware from "../middlewares/base.js";
+import chalk from "chalk";
+
 const tree = {
 	command: "tree",
 	describe:
 		"Outputs the dependency tree of the current project to stdout. " +
 		"It takes all relevant parameters of ui5 build into account.",
-	middlewares: [require("../middlewares/base.js")]
+	middlewares: [baseMiddleware]
 };
 
 tree.builder = function(cli) {
@@ -17,29 +20,27 @@ tree.builder = function(cli) {
 };
 
 tree.handler = async function(argv) {
-	const chalk = require("chalk");
-
 	let startTime;
 	let elapsedTime;
 	if (argv.xPerf) {
 		startTime = process.hrtime();
 	}
-	const {generateProjectGraph} = require("@ui5/project");
+	const {graphFromStaticFile, graphFromPackageDependencies} = await import("@ui5/project/graph");
 	let graph;
 	if (argv.dependencyDefinition) {
-		graph = await generateProjectGraph.usingStaticFile({
+		graph = await graphFromStaticFile({
 			filePath: argv.dependencyDefinition,
 			versionOverride: argv.frameworkVersion
 		});
 	} else {
-		graph = await generateProjectGraph.usingNodePackageDependencies({
+		graph = await graphFromPackageDependencies({
 			rootConfigPath: argv.config,
 			versionOverride: argv.frameworkVersion
 		});
 	}
 
 	if (argv.xPerf) {
-		elapsedTime = getElapsedTime(startTime);
+		elapsedTime = await getElapsedTime(startTime);
 	}
 
 	const projects = {};
@@ -98,9 +99,9 @@ tree.handler = async function(argv) {
 	}
 };
 
-function getElapsedTime(startTime) {
+async function getElapsedTime(startTime) {
 	const timeDiff = process.hrtime(startTime);
-	const prettyHrtime = require("pretty-hrtime");
+	const {default: prettyHrtime} = await import("pretty-hrtime");
 	return prettyHrtime(timeDiff);
 }
-module.exports = tree;
+export default tree;

package/lib/cli/commands/use.js

@@ -1,8 +1,10 @@
 // Use
+import baseMiddleware from "../middlewares/base.js";
+
 const useCommand = {
 	command: "use <framework-info>",
 	describe: "Initialize or update the project's framework configuration.",
-	middlewares: [require("../middlewares/base.js")]
+	middlewares: [baseMiddleware]
 };
 
 useCommand.builder = function(cli) {
@@ -60,7 +62,8 @@ useCommand.handler = async function(argv) {
 		config: argv.config
 	};
 
-	const {usedFramework, usedVersion, yamlUpdated} = await require("../../framework/use")({
+	const {default: use} = await import("../../framework/use.js");
+	const {usedFramework, usedVersion, yamlUpdated} = await use({
 		projectGraphOptions,
 		frameworkOptions
 	});
@@ -79,4 +82,4 @@ useCommand.handler = async function(argv) {
 	}
 };
 
-module.exports = useCommand;
+export default useCommand;

package/lib/cli/commands/versions.js

@@ -1,5 +1,8 @@
-// Versions
-const baseMiddleware = require("../middlewares/base.js");
+import baseMiddleware from "../middlewares/base.js";
+import {createRequire} from "node:module";
+
+// Using CommonsJS require as importing json files causes an ExperimentalWarning
+const require = createRequire(import.meta.url);
 
 const versions = {
 	command: "versions",
@@ -18,20 +21,20 @@ versions.getVersion = (pkg) => {
 };
 
 versions.handler = async function() {
-	const cliVersion = versions.getVersion("../../..");
-	const builderVersion = versions.getVersion("@ui5/builder");
-	const serverVersion = versions.getVersion("@ui5/server");
-	const fsVersion = versions.getVersion("@ui5/fs");
-	const projectVersion = versions.getVersion("@ui5/project");
-	const loggerVersion = versions.getVersion("@ui5/logger");
-	console.log(`
-@ui5/cli:      ${cliVersion}
-@ui5/builder:  ${builderVersion}
-@ui5/server:   ${serverVersion}
-@ui5/fs:       ${fsVersion}
-@ui5/project:  ${projectVersion}
-@ui5/logger:   ${loggerVersion}
-	`);
+	const output = (await Promise.all(
+		[
+			"@ui5/cli",
+			"@ui5/builder",
+			"@ui5/server",
+			"@ui5/fs",
+			"@ui5/project",
+			"@ui5/logger",
+		].map(async (id) => {
+			return (id + ":").padEnd(15) + versions.getVersion(id);
+		})
+	)).join("\n");
+
+	console.log(`\n${output}\n`);
 };
 
-module.exports = versions;
+export default versions;

package/lib/cli/middlewares/base.js

@@ -1,4 +1,4 @@
-const logger = require("./logger");
+import {initLogger} from "./logger.js";
 /**
  * Base middleware for CLI commands.
  *
@@ -7,7 +7,7 @@ const logger = require("./logger");
  * @param {object} argv The CLI arguments
  * @returns {object}
  */
-module.exports = function(argv) {
-	logger.init(argv);
+export default async function(argv) {
+	await initLogger(argv);
 	return {};
-};
+}

package/lib/cli/middlewares/logger.js

@@ -1,23 +1,22 @@
+
+import {getVersion} from "../version.js";
 /**
  * Logger middleware used as one of default middlewares by tooling
  *
  * @param {object} argv logger arguments
  * @returns {object} logger instance or null
  */
-function init(argv) {
+export async function initLogger(argv) {
 	if (!argv.verbose && !argv.loglevel) return null;
 
-	const logger = require("@ui5/logger");
+	const {default: logger} = await import("@ui5/logger");
 	if (argv.loglevel) {
 		logger.setLevel(argv.loglevel);
 	}
 	if (argv.verbose) {
 		logger.setLevel("verbose");
-		const version = require("../version").get();
-		logger.getLogger("cli:middlewares:base").verbose(`using @ui5/cli version ${version}`);
+		logger.getLogger("cli:middlewares:base").verbose(`using @ui5/cli version ${getVersion()}`);
 		logger.getLogger("cli:middlewares:base").verbose(`using node version ${process.version}`);
 	}
 	return logger;
 }
-
-module.exports = {init};

package/lib/cli/version.js

@@ -1,11 +1,9 @@
 let version;
 
-// This module holds the CLI's version information (set via ui5.js) for later retrieval (e.g. from middlewares/logger)
-module.exports = {
-	set: function(v) {
-		version = v;
-	},
-	get: function() {
-		return version;
-	}
-};
+// This module holds the CLI's version information (set via cli.js) for later retrieval (e.g. from middlewares/logger)
+export function setVersion(v) {
+	version = v;
+}
+export function getVersion() {
+	return version;
+}

package/lib/framework/add.js

@@ -1,4 +1,4 @@
-const {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} = require("./utils");
+import {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} from "./utils.js";
 
 /**
  * Adds the given set of libraries to the framework libraries section in the ui5.yaml
@@ -7,7 +7,7 @@ const {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} =
  * @param {object} parameters.projectGraphOptions
  * @param {object} parameters.libraries
  */
-module.exports = async function({projectGraphOptions, libraries}) {
+export default async function({projectGraphOptions, libraries}) {
 	const project = await getRootProjectConfiguration(projectGraphOptions);
 
 	if (!isValidSpecVersion(project.getSpecVersion())) {
@@ -63,7 +63,8 @@ module.exports = async function({projectGraphOptions, libraries}) {
 	// Try to update YAML file but still return with name and resolved version in case it failed
 	let yamlUpdated = false;
 	try {
-		await require("./updateYaml")({
+		const {default: updateYaml} = await import("./updateYaml.js");
+		await updateYaml({
 			project,
 			configPathOverride: projectGraphOptions.config,
 			data: {
@@ -81,4 +82,4 @@ module.exports = async function({projectGraphOptions, libraries}) {
 	return {
 		yamlUpdated
 	};
-};
+}

package/lib/framework/remove.js

@@ -1,6 +1,7 @@
-const {getRootProjectConfiguration, isValidSpecVersion} = require("./utils");
-const log = require("@ui5/logger").getLogger("cli:framework:remove");
+import {getRootProjectConfiguration, isValidSpecVersion} from "./utils.js";
+import logger from "@ui5/logger";
 
+const log = logger.getLogger("cli:framework:remove");
 
 /**
  * Removes the given set of libraries from the framework libraries section in the ui5.yaml
@@ -9,7 +10,7 @@ const log = require("@ui5/logger").getLogger("cli:framework:remove");
  * @param {object} parameters.projectGraphOptions
  * @param {object} parameters.libraries
  */
-module.exports = async function({projectGraphOptions, libraries}) {
+export default async function({projectGraphOptions, libraries}) {
 	const project = await getRootProjectConfiguration(projectGraphOptions);
 
 	if (!isValidSpecVersion(project.getSpecVersion())) {
@@ -61,7 +62,8 @@ module.exports = async function({projectGraphOptions, libraries}) {
 	// Try to update YAML file but still return with name and resolved version in case it failed
 	let yamlUpdated = false;
 	try {
-		await require("./updateYaml")({
+		const {default: updateYaml} = await import("./updateYaml.js");
+		await updateYaml({
 			project,
 			configPathOverride: projectGraphOptions.config,
 			data: {
@@ -79,4 +81,4 @@ module.exports = async function({projectGraphOptions, libraries}) {
 	return {
 		yamlUpdated
 	};
-};
+}

package/lib/framework/updateYaml.js

@@ -1,7 +1,10 @@
-const path = require("path");
-const log = require("@ui5/logger").getLogger("cli:framework:updateYaml");
-const {loadAll, dump} = require("js-yaml");
-const {fromYaml, getPosition, getValue} = require("data-with-position");
+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 logger from "@ui5/logger";
+
+const log = logger.getLogger("cli:framework:updateYaml");
 
 function getProjectYamlDocument({project, configFile, configPath}) {
 	const configs = loadAll(configFile, undefined, {
@@ -137,12 +140,7 @@ function formatValue(value, indent) {
 	}
 }
 
-module.exports = async function({project, configPathOverride, data}) {
-	const {promisify} = require("util");
-	const fs = require("fs");
-	const readFile = promisify(fs.readFile);
-	const writeFile = promisify(fs.writeFile);
-
+export default async function({project, configPathOverride, data}) {
 	let configPath;
 	if (configPathOverride) {
 		if (path.isAbsolute(configPathOverride)) {
@@ -274,4 +272,4 @@ module.exports = async function({project, configPathOverride, data}) {
 	}
 
 	await writeFile(configPath, adoptedYaml);
-};
+}

package/lib/framework/use.js

@@ -1,4 +1,4 @@
-const {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} = require("./utils");
+import {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} from "./utils.js";
 
 async function resolveVersion({frameworkName, frameworkVersion}, resolverOptions) {
 	return await getFrameworkResolver(frameworkName).resolveVersion(frameworkVersion, resolverOptions);
@@ -22,7 +22,7 @@ function getEffectiveFrameworkName({project, frameworkOptions}) {
 	}
 }
 
-module.exports = async function({projectGraphOptions, frameworkOptions}) {
+export default async function({projectGraphOptions, frameworkOptions}) {
 	const project = await getRootProjectConfiguration(projectGraphOptions);
 
 	if (!isValidSpecVersion(project.getSpecVersion())) {
@@ -49,7 +49,8 @@ module.exports = async function({projectGraphOptions, frameworkOptions}) {
 	// Try to update YAML file but still return with name and resolved version in case it failed
 	let yamlUpdated = false;
 	try {
-		await require("./updateYaml")({
+		const {default: updateYaml} = await import("./updateYaml.js");
+		await updateYaml({
 			project,
 			configPathOverride: projectGraphOptions.config,
 			data: {
@@ -67,4 +68,4 @@ module.exports = async function({projectGraphOptions, frameworkOptions}) {
 		usedFramework: framework.name,
 		usedVersion: framework.version || null
 	};
-};
+}

package/lib/framework/utils.js

@@ -1,32 +1,37 @@
-module.exports = {
-	getRootProjectConfiguration: async function(projectGraphOptions) {
-		const {generateProjectGraph} = require("@ui5/project");
+import {graphFromStaticFile, graphFromPackageDependencies} from "@ui5/project/graph";
+import Sapui5Resolver from "@ui5/project/ui5Framework/Sapui5Resolver";
+import Openui5Resolver from "@ui5/project/ui5Framework/Openui5Resolver";
 
-		let graph;
-		if (projectGraphOptions.dependencyDefinition) {
-			graph = await generateProjectGraph.usingStaticFile({
-				filePath: projectGraphOptions.dependencyDefinition,
-				resolveFrameworkDependencies: false
-			});
-		} else {
-			graph = await generateProjectGraph.usingNodePackageDependencies({
-				rootConfigPath: projectGraphOptions.config,
-				resolveFrameworkDependencies: false
-			});
-		}
+export async function getRootProjectConfiguration(projectGraphOptions) {
+	let graph;
+	if (projectGraphOptions.dependencyDefinition) {
+		graph = await graphFromStaticFile({
+			filePath: projectGraphOptions.dependencyDefinition,
+			resolveFrameworkDependencies: false
+		});
+	} else {
+		graph = await graphFromPackageDependencies({
+			rootConfigPath: projectGraphOptions.config,
+			resolveFrameworkDependencies: false
+		});
+	}
+
+	return graph.getRoot();
+}
 
-		return graph.getRoot();
-	},
-	getFrameworkResolver: function(frameworkName) {
-		if (frameworkName === "SAPUI5") {
-			return require("@ui5/project").ui5Framework.Sapui5Resolver;
-		} else if (frameworkName === "OpenUI5") {
-			return require("@ui5/project").ui5Framework.Openui5Resolver;
-		} else {
-			throw new Error("Invalid framework.name: " + frameworkName);
-		}
-	},
-	isValidSpecVersion: function(specVersion) {
-		return specVersion && (specVersion !== "0.1" && specVersion !== "1.0" && specVersion !== "1.1");
+export function getFrameworkResolver(frameworkName) {
+	if (frameworkName === "SAPUI5") {
+		return Sapui5Resolver;
+	} else if (frameworkName === "OpenUI5") {
+		return Openui5Resolver;
+	} else {
+		throw new Error("Invalid framework.name: " + frameworkName);
 	}
-};
+}
+
+export function isValidSpecVersion(specVersion) {
+	// Only checks for a string and versions that are not supported
+	// The CLI relies on the @ui5/project to correctly verify the version
+	return typeof specVersion === "string" && specVersion !== "" &&
+		specVersion !== "0.1" && specVersion !== "1.0" && specVersion !== "1.1";
+}

package/lib/init/init.js

@@ -1,8 +1,6 @@
-const {promisify} = require("util");
-const path = require("path");
-const fs = require("fs");
-const readFile = promisify(fs.readFile);
-const fsHelper = require("../utils/fsHelper");
+import path from "node:path";
+import {readFile} from "node:fs/promises";
+import {pathsExist} from "../utils/fsHelper.js";
 
 /**
  * Reads the package.json file and returns its content
@@ -54,13 +52,18 @@ function getProjectType(hasWebapp, hasSrc, hasTest) {
 	throw new Error(message);
 }
 
+/**
+ * @module @ui5/cli/init
+ */
+
 /**
  * Initiates the projects <b>ui5.yaml</b> configuration file.
  *
  * Checks the package.json and tries to determine the project type. If the <b>ui5.yaml</b> file does not exist,
  * it is created with the basic project configuration.
  *
- * @module @ui5/cli/init
+ * @function default
+ * @static
  * @param {string} cwd Current working directory
  * @returns {Promise} Promise resolving with the project configuration object
  */
@@ -87,12 +90,10 @@ async function init({cwd = "./"} = {}) {
 		throw new Error("Initialization not possible: Missing 'name' in package.json");
 	}
 
-	const [hasWebapp, hasSrc, hasTest] = await fsHelper.pathsExist(["webapp", "src", "test"], cwd);
+	const [hasWebapp, hasSrc, hasTest] = await pathsExist(["webapp", "src", "test"], cwd);
 	projectConfig.type = getProjectType(hasWebapp, hasSrc, hasTest);
 
 	return projectConfig;
 }
 
-module.exports = {
-	init: init
-};
+export default init;

package/lib/utils/fsHelper.js

@@ -1,7 +1,5 @@
-const {promisify} = require("util");
-const fs = require("fs");
-const stat = promisify(fs.stat);
-const path = require("path");
+import {stat} from "node:fs/promises";
+import path from "node:path";
 
 /**
  * Checks if a file or path exists
@@ -10,7 +8,7 @@ const path = require("path");
  * @param {string} filePath Path to check
  * @returns {Promise} Promise resolving with true if the file or path exists
  */
-async function exists(filePath) {
+export async function exists(filePath) {
 	try {
 		await stat(filePath);
 		return true;
@@ -32,12 +30,6 @@ async function exists(filePath) {
  * @param {string} cwd Current working directory
  * @returns {Promise} Resolving with an array of booleans for each path
  */
-async function pathsExist(paths, cwd) {
+export async function pathsExist(paths, cwd) {
 	return await Promise.all(paths.map((p) => exists(path.join(cwd, p))));
 }
-
-module.exports = {
-	exists,
-	pathsExist
-};
-