@ui5/cli 3.0.0-alpha.0 → 3.0.0-alpha.11

package/lib/framework/add.js

@@ -1,33 +1,40 @@
 const {getRootProjectConfiguration, getFrameworkResolver, isValidSpecVersion} = require("./utils");
 
-module.exports = async function({normalizerOptions, libraries}) {
-	const project = await getRootProjectConfiguration({normalizerOptions});
+/**
+ * Adds the given set of libraries to the framework libraries section in the ui5.yaml
+ *
+ * @param {object} parameters Parameters
+ * @param {object} parameters.projectGraphOptions
+ * @param {object} parameters.libraries
+ */
+module.exports = async function({projectGraphOptions, libraries}) {
+	const project = await getRootProjectConfiguration(projectGraphOptions);
 
-	if (!isValidSpecVersion(project.specVersion)) {
+	if (!isValidSpecVersion(project.getSpecVersion())) {
 		throw new Error(
 			`ui5 add command requires specVersion "2.0" or higher. ` +
-			`Project ${project.metadata.name} uses specVersion "${project.specVersion}"`
+			`Project ${project.getName()} uses specVersion "${project.getSpecVersion()}"`
 		);
 	}
 
-	if (!project.framework) {
+	if (!project.getFrameworkName()) {
 		throw new Error(
-			`Project ${project.metadata.name} is missing a framework configuration. ` +
+			`Project ${project.getName()} is missing a framework configuration. ` +
 			`Please use "ui5 use" to configure a framework and version.`
 		);
 	}
-	if (!project.framework.version) {
+	if (!project.getFrameworkVersion()) {
 		throw new Error(
-			`Project ${project.metadata.name} does not define a framework version configuration. ` +
+			`Project ${project.getName()} does not define a framework version configuration. ` +
 			`Please use "ui5 use" to configure a version.`
 		);
 	}
 
-	const Resolver = getFrameworkResolver(project.framework.name);
+	const Resolver = getFrameworkResolver(project.getFrameworkName());
 
 	const resolver = new Resolver({
-		cwd: project.path,
-		version: project.framework.version
+		cwd: project.getPath(),
+		version: project.getFrameworkVersion()
 	});
 
 	// Get metadata of all libraries to verify that they can be installed
@@ -35,21 +42,20 @@ module.exports = async function({normalizerOptions, libraries}) {
 		try {
 			await resolver.getLibraryMetadata(name);
 		} catch (err) {
-			throw new Error(`Failed to find ${project.framework.name} framework library ${name}: ` + err.message);
+			throw new Error(`Failed to find ${project.getFrameworkName()} framework library ${name}: ` + err.message);
 		}
 	}));
 
 	// Shallow copy of given libraries to not modify the input parameter when pushing other libraries
 	const allLibraries = [...libraries];
 
-	if (project.framework.libraries) {
-		project.framework.libraries.forEach((library) => {
-			// Don't add libraries twice!
-			if (allLibraries.findIndex(($) => $.name === library.name) === -1) {
-				allLibraries.push(library);
-			}
-		});
-	}
+	project.getFrameworkDependencies().forEach((library) => {
+		// Don't add libraries twice!
+		if (allLibraries.findIndex(($) => $.name === library.name) === -1) {
+			allLibraries.push(library);
+		}
+	});
+
 	allLibraries.sort((a, b) => {
 		return a.name.localeCompare(b.name);
 	});
@@ -59,6 +65,7 @@ module.exports = async function({normalizerOptions, libraries}) {
 	try {
 		await require("./updateYaml")({
 			project,
+			configPathOverride: projectGraphOptions.config,
 			data: {
 				framework: {
 					libraries: allLibraries

package/lib/framework/remove.js

@@ -6,39 +6,39 @@ const log = require("@ui5/logger").getLogger("cli:framework:remove");
  * Removes the given set of libraries from the framework libraries section in the ui5.yaml
  *
  * @param {object} parameters Parameters
- * @param {object} parameters.normalizerOptions
+ * @param {object} parameters.projectGraphOptions
  * @param {object} parameters.libraries
  */
-module.exports = async function({normalizerOptions, libraries}) {
-	const project = await getRootProjectConfiguration({normalizerOptions});
+module.exports = async function({projectGraphOptions, libraries}) {
+	const project = await getRootProjectConfiguration(projectGraphOptions);
 
-	if (!isValidSpecVersion(project.specVersion)) {
+	if (!isValidSpecVersion(project.getSpecVersion())) {
 		throw new Error(
 			`ui5 remove command requires specVersion "2.0" or higher. ` +
-			`Project ${project.metadata.name} uses specVersion "${project.specVersion}"`
+			`Project ${project.getName()} uses specVersion "${project.getSpecVersion()}"`
 		);
 	}
 
-	if (!project.framework) {
+	if (!project.getFrameworkName()) {
 		throw new Error(
-			`Project ${project.metadata.name} is missing a framework configuration. ` +
+			`Project ${project.getName()} is missing a framework configuration. ` +
 			`Please use "ui5 use" to configure a framework and version.`
 		);
 	}
-	if (!project.framework.version) {
+	if (!project.getFrameworkVersion()) {
 		throw new Error(
-			`Project ${project.metadata.name} does not define a framework version configuration. ` +
+			`Project ${project.getName()} does not define a framework version configuration. ` +
 			`Please use "ui5 use" to configure a version.`
 		);
 	}
 
-	if (!project.framework.libraries) {
+	if (!project.getFrameworkDependencies().length) {
 		throw new Error(
-			`Project ${project.metadata.name} does not define framework libraries.`
+			`Project ${project.getName()} does not define framework libraries.`
 		);
 	}
 
-	const allLibraries = [...project.framework.libraries];
+	const allLibraries = [...project.getFrameworkDependencies()];
 
 	libraries.forEach((library) => {
 		const iIndexToRemove = allLibraries.findIndex(($) => $.name === library.name);
@@ -46,7 +46,7 @@ module.exports = async function({normalizerOptions, libraries}) {
 			// do not fail here just log, because the framework library is not present afterwards
 			log.warn(
 				`Failed to remove framework library ${library.name} from project ` +
-				`${project.metadata.name} because it is not present.`
+				`${project.getName()} because it is not present.`
 			);
 		} else {
 			allLibraries.splice(iIndexToRemove, 1);
@@ -63,6 +63,7 @@ module.exports = async function({normalizerOptions, libraries}) {
 	try {
 		await require("./updateYaml")({
 			project,
+			configPathOverride: projectGraphOptions.config,
 			data: {
 				framework: {
 					libraries: allLibraries

package/lib/framework/updateYaml.js

@@ -9,11 +9,11 @@ function getProjectYamlDocument({project, configFile, configPath}) {
 	});
 
 	const projectDocumentIndex = configs.findIndex((config) => {
-		return config.metadata && config.metadata.name === project.metadata.name;
+		return config.metadata && config.metadata.name === project.getName();
 	});
 	if (projectDocumentIndex === -1) {
 		throw new Error(
-			`Could not find project with name ${project.metadata.name} in YAML: ${configPath}`
+			`Could not find project with name ${project.getName()} in YAML: ${configPath}`
 		);
 	}
 
@@ -137,13 +137,23 @@ function formatValue(value, indent) {
 	}
 }
 
-module.exports = async function({project, data}) {
+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);
 
-	const configPath = project.configPath || path.join(project.path, "ui5.yaml");
+	let configPath;
+	if (configPathOverride) {
+		if (path.isAbsolute(configPathOverride)) {
+			configPath = configPathOverride;
+		} else {
+			configPath = path.join(project.getPath(), configPathOverride);
+		}
+	} else {
+		configPath = path.join(project.getPath(), "ui5.yaml");
+	}
+
 	const configFile = await readFile(configPath, {encoding: "utf8"});
 
 	let {

package/lib/framework/use.js

@@ -5,13 +5,10 @@ async function resolveVersion({frameworkName, frameworkVersion}, resolverOptions
 }
 
 function getEffectiveFrameworkName({project, frameworkOptions}) {
-	if (!project.framework && !frameworkOptions.name) {
+	if (!project.getFrameworkName() && !frameworkOptions.name) {
 		throw new Error("No framework configuration defined. Make sure to also provide the framework name.");
 	}
-	if (project.framework && !project.framework.name) {
-		// This should not happen as the configuration should have been validated against the schema
-		throw new Error(`Project ${project.metadata.name} does not define a framework name configuration`);
-	}
+
 	if (frameworkOptions.name) {
 		if (frameworkOptions.name.toLowerCase() === "openui5") {
 			return "OpenUI5";
@@ -21,17 +18,17 @@ function getEffectiveFrameworkName({project, frameworkOptions}) {
 			throw new Error("Invalid framework name: " + frameworkOptions.name);
 		}
 	} else {
-		return project.framework.name;
+		return project.getFrameworkName();
 	}
 }
 
-module.exports = async function({normalizerOptions, frameworkOptions}) {
-	const project = await getRootProjectConfiguration({normalizerOptions});
+module.exports = async function({projectGraphOptions, frameworkOptions}) {
+	const project = await getRootProjectConfiguration(projectGraphOptions);
 
-	if (!isValidSpecVersion(project.specVersion)) {
+	if (!isValidSpecVersion(project.getSpecVersion())) {
 		throw new Error(
 			`ui5 use command requires specVersion "2.0" or higher. ` +
-			`Project ${project.metadata.name} uses specVersion "${project.specVersion}"`
+			`Project ${project.getName()} uses specVersion "${project.getSpecVersion()}"`
 		);
 	}
 
@@ -39,13 +36,13 @@ module.exports = async function({normalizerOptions, frameworkOptions}) {
 		name: getEffectiveFrameworkName({project, frameworkOptions})
 	};
 
-	const frameworkVersion = frameworkOptions.version || (project.framework && project.framework.version);
+	const frameworkVersion = frameworkOptions.version || project.getFrameworkVersion();
 	if (frameworkVersion) {
 		framework.version = await resolveVersion({
 			frameworkName: framework.name,
 			frameworkVersion
 		}, {
-			cwd: project.path
+			cwd: project.getPath()
 		});
 	}
 
@@ -54,6 +51,7 @@ module.exports = async function({normalizerOptions, frameworkOptions}) {
 	try {
 		await require("./updateYaml")({
 			project,
+			configPathOverride: projectGraphOptions.config,
 			data: {
 				framework: framework
 			}

package/lib/framework/utils.js

@@ -1,17 +1,21 @@
 module.exports = {
-	getRootProjectConfiguration: async function({normalizerOptions}) {
-		const {normalizer, projectPreprocessor} = require("@ui5/project");
+	getRootProjectConfiguration: async function(projectGraphOptions) {
+		const {generateProjectGraph} = require("@ui5/project");
 
-		const tree = await normalizer.generateDependencyTree(normalizerOptions);
-
-		if (normalizerOptions.configPath) {
-			tree.configPath = normalizerOptions.configPath;
+		let graph;
+		if (projectGraphOptions.dependencyDefinition) {
+			graph = await generateProjectGraph.usingStaticFile({
+				filePath: projectGraphOptions.dependencyDefinition,
+				resolveFrameworkDependencies: false
+			});
+		} else {
+			graph = await generateProjectGraph.usingNodePackageDependencies({
+				rootConfigPath: projectGraphOptions.config,
+				resolveFrameworkDependencies: false
+			});
 		}
 
-		// Prevent dependencies from being processed
-		tree.dependencies = [];
-
-		return projectPreprocessor.processTree(tree);
+		return graph.getRoot();
 	},
 	getFrameworkResolver: function(frameworkName) {
 		if (frameworkName === "SAPUI5") {