feat(project): Offer configPath property to workspace configs (workspace/1.1)

internal/documentation/docs/pages/Workspace.md

@@ -5,7 +5,7 @@
 
 ::: details
 ```yaml title="ui5-workspace.yaml"
-specVersion: workspace/1.0
+specVersion: workspace/1.1
 metadata:
     name: default
 dependencyManagement:
@@ -23,14 +23,14 @@ Workspaces are typically configured in a `ui5-workspace.yaml` file, located next
 
 ::: details Example
 ```yaml title="ui5-workspace.yaml"
-specVersion: workspace/1.0
+specVersion: workspace/1.1
 metadata:
     name: default
 dependencyManagement:
    	    resolutions:
    	    - path: ../heavy.library
 ---
-specVersion: workspace/1.0
+specVersion: workspace/1.1
 metadata:
     name: extended
 dependencyManagement:
@@ -52,14 +52,14 @@ This concept has been discussed in an RFC: [RFC 0006 Local Dependency Resolution
 A UI5 Workspace configuration must define a specification version (`specVersion`) compatible with its configuration. For more information, see [Workspace Specification Versions](#workspace-specification-versions).
 
 ```yaml
-specVersion: "workspace/1.0"
+specVersion: "workspace/1.1"
 ```
 
 ### Metadata
 
 ::: details Example
 ```yaml
-specVersion: workspace/1.0
+specVersion: workspace/1.1
 metadata:
     name: dolphin
 ```
@@ -91,7 +91,7 @@ UI5 Workspace configurations allow to influence the dependency resolution when w
 
 ::: details
 ```yaml
-specVersion: workspace/1.0
+specVersion: workspace/1.1
 metadata:
     name: dolphin
 dependencyManagement:
@@ -119,11 +119,24 @@ Paths must be written in POSIX (i.e. using only forward slashes `/` as path segm
 
 Note that this configuration only affects the resolution of dependencies which have already been found during the regular dependency resolution process of a project. For example, if a workspace resolution path resolves to a project that would otherwise not be part of the dependency tree of the current root project, it will not be added to the dependency tree. Also, transitive dependencies of resolved projects are not being followed.
 
+#### configPath
+
+*Available since `workspace/1.1`*
+
+```yaml
+dependencyManagement:
+    resolutions:
+        - path: ../test.library
+          configPath: custom-config.yaml
+```
+
+By default, UI5 CLI looks for a `ui5.yaml` at the root of the resolved module. The optional `configPath` property allows pointing to a different configuration file within the module directory. The path must be written in POSIX notation and must be **relative to the resolution `path`**.
+
 ## Workspace Specification Versions
 A workspace configuration must define a Specification Version by setting the `specVersion` property. UI5 CLI uses this information to detect whether the currently installed version is compatible with a workspace's configuration.
 
 ```yaml
-specVersion: "workspace/1.0"
+specVersion: "workspace/1.1"
 [...]
 ```
 
@@ -142,8 +155,15 @@ Unless otherwise noted in the table below, UI5 CLI modules are backward-compatib
 
 Version | UI5 CLI Release
 --- | ---
+**`workspace/1.1`** | v4.1.0+
 **`workspace/1.0`** | v3.0.0+
 
+### Specification Version `workspace/1.1`
+
+Added [`configPath`](#configpath) property to resolution entries.
+
+Specification Version `workspace/1.1` configurations are compatible with [UI5 CLI](https://github.com/UI5/cli) v4.1.0 and above.
+
 ### Specification Version `workspace/1.0`
 
 Initial version.

packages/project/lib/graph/Module.js

@@ -308,8 +308,9 @@ class Module {
 			}
 			if (!configResource) {
 				if (configPath !== DEFAULT_CONFIG_PATH) {
-					throw new Error("Failed to read configuration for module " +
-							`${this.getId()}: Could not find configuration file in module at path '${configPath}'`);
+					throw new Error(`Failed to read configuration for module ` +
+							`${this.getId()}: Could not find configuration file in module at path `+
+							`'${this._configPath}'`);
 				}
 				return null;
 			}

packages/project/lib/graph/Workspace.js

@@ -138,13 +138,38 @@ class Workspace {
 			};
 		}
 
+		// Detect duplicate resolutions targeting the same library
+		const seenLibraryNames = [];
+		for (const {path: resolutionPath} of resolutions) {
+			if (!resolutionPath) {
+				continue;
+			}
+			const libraryName = path.basename(resolutionPath); // "../collection/library.a" -> "library.a"
+			if (seenLibraryNames.includes(libraryName)) {
+				throw new Error(
+					`Multiple resolutions for the same library '${libraryName}' ` +
+					`in workspace '${this.getName()}' exist.`);
+			}
+			seenLibraryNames.push(libraryName);
+		}
+
 		let resolvedModules = await Promise.all(resolutions.map(async (resolutionConfig) => {
 			if (!resolutionConfig.path) {
 				throw new Error(
 					`Missing property 'path' in dependency resolution configuration of workspace ${this.getName()}`);
 			}
+			if (path.isAbsolute(resolutionConfig.path)) {
+				throw new Error(
+					`Absolute paths are not allowed in workspace configurations of dependencies. ` +
+					`Found '${resolutionConfig.path}' in workspace '${this.getName()}'`);
+			}
+			if (resolutionConfig.configPath && path.isAbsolute(resolutionConfig.configPath)) {
+				throw new Error(
+					`Absolute config paths are not allowed in workspace configurations of dependencies. ` +
+					`Found '${resolutionConfig.configPath}' in workspace '${this.getName()}'`);
+			}
 			return await this._getModulesFromPath(
-				this.#cwd, resolutionConfig.path);
+				this.#cwd, resolutionConfig.path, resolutionConfig.configPath);
 		}));
 
 		// Flatten array since package-workspaces might have resolved to multiple modules for a single resolution
@@ -175,7 +200,7 @@ class Workspace {
 		};
 	}
 
-	async _getModulesFromPath(cwd, relPath, failOnMissingFiles = true) {
+	async _getModulesFromPath(cwd, relPath, configPath, failOnMissingFiles = true) {
 		const nodePath = path.join(cwd, relPath);
 		if (this.#visitedNodePaths.has(nodePath)) {
 			log.verbose(`Module located at ${nodePath} has already been visited`);
@@ -235,7 +260,8 @@ class Workspace {
 
 			const resolvedModules = new Map();
 			await Promise.all(searchPaths.map(async (pkgPath) => {
-				const modules = await this._getModulesFromPath(nodePath, pkgPath, staticPatterns.includes(pkgPath));
+				const modules =
+					await this._getModulesFromPath(nodePath, pkgPath, configPath, staticPatterns.includes(pkgPath));
 				modules.forEach((module) => {
 					const id = module.getId();
 					if (!resolvedModules.get(id)) {
@@ -248,7 +274,8 @@ class Workspace {
 			return [new Module({
 				id: pkg.name,
 				version: pkg.version,
-				modulePath: nodePath
+				modulePath: nodePath,
+				configPath: configPath ? path.resolve(nodePath, configPath) : undefined,
 			})];
 		}
 	}

packages/project/lib/validation/schema/ui5-workspace.json

@@ -9,8 +9,8 @@
 	"additionalProperties": false,
 	"properties": {
 		"specVersion": {
-			"enum": ["workspace/1.0"],
-			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"workspace/1.0\"\nFor details, see: https://ui5.github.io/cli/stable/pages/Workspace/#workspace-specification-versions"
+			"enum": ["workspace/1.1", "workspace/1.0"],
+			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"workspace/1.0\", \"workspace/1.1\".\nFor details, see: https://ui5.github.io/cli/stable/pages/Workspace/#workspace-specification-versions"
 		},
 		"metadata": {
 			"$ref": "#/definitions/metadata"
@@ -19,6 +19,31 @@
 			"$ref": "#/definitions/dependencyManagement"
 		}
 	},
+	"if": {
+		"properties": {"specVersion": {"const": "workspace/1.0"}}
+	},
+	"then": {
+		"properties": {
+			"dependencyManagement": {
+				"type": "object",
+				"properties": {
+					"resolutions": {
+						"type": "array",
+						"items": {
+							"if": {"type": "object"},
+							"then": {
+								"not": {
+									"type": "object",
+									"required": ["configPath"]
+								},
+								"errorMessage": "\"configPath\" is only supported for specVersion \"workspace/1.1\" and higher"
+							}
+						}
+					}
+				}
+			}
+		}
+	},
 	"definitions": {
 		"metadata": {
 			"type": "object",
@@ -42,13 +67,15 @@
 			"properties": {
 				"resolutions": {
 					"type": "array",
-
 					"items": {
 						"type": "object",
 						"additionalProperties": false,
 						"properties": {
 							"path": {
 								"type": "string"
+							},
+							"configPath": {
+								"type": "string"
 							}
 						}
 					}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.c/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "library.c",
+  "version": "1.0.0",
+  "description": "Simple SAPUI5 based library"
+}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.c/src/library/a/.library

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd" >
+
+	<name>library.a</name>
+	<vendor>SAP SE</vendor>
+	<copyright>Some fancy copyright ${currentYear}</copyright>
+	<version>${version}</version>
+
+	<documentation>Library A</documentation>
+
+	<dependencies>
+		<dependency>
+			<libraryName>library.d</libraryName>
+		</dependency>
+	</dependencies>
+
+</library>

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.c/ui5-another-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.c.another.custom

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.c/ui5-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.c.custom

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.c/ui5.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.c

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.d/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "library.d",
+  "version": "1.0.0",
+  "description": "Simple SAPUI5 based library"
+}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.d/src/library/b/.library

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd" >
+
+	<name>library.b</name>
+	<vendor>SAP SE</vendor>
+	<copyright>Some fancy copyright ${currentYear}</copyright>
+	<version>${version}</version>
+
+	<documentation>Library B</documentation>
+
+	<dependencies>
+		<dependency>
+			<libraryName>library.d</libraryName>
+		</dependency>
+	</dependencies>
+
+</library>

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.d/ui5-another-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.d.another.custom

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.d/ui5-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.d.custom

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/library.d/ui5.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.d

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/collection.a/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "collection",
+  "version": "1.0.0",
+  "description": "Simple Collection",
+  "workspaces": [
+    "library.c",
+    "library.d"
+  ]
+}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.a/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "library.a",
+  "version": "1.0.0",
+  "description": "Simple SAPUI5 based library"
+}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.a/src/library/a/.library

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd" >
+
+	<name>library.a</name>
+	<vendor>SAP SE</vendor>
+	<copyright>Some fancy copyright ${currentYear}</copyright>
+	<version>${version}</version>
+
+	<documentation>Library A</documentation>
+
+	<dependencies>
+		<dependency>
+			<libraryName>library.d</libraryName>
+		</dependency>
+	</dependencies>
+
+</library>

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.a/ui5-another-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.a.another.custom

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.a/ui5.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.a

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.b/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "library.b",
+  "version": "1.0.0",
+  "description": "Simple SAPUI5 based library"
+}

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.b/src/library/b/.library

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<library xmlns="http://www.sap.com/sap.ui.library.xsd" >
+
+	<name>library.b</name>
+	<vendor>SAP SE</vendor>
+	<copyright>Some fancy copyright ${currentYear}</copyright>
+	<version>${version}</version>
+
+	<documentation>Library B</documentation>
+
+	<dependencies>
+		<dependency>
+			<libraryName>library.d</libraryName>
+		</dependency>
+	</dependencies>
+
+</library>

packages/project/test/fixtures/collection.c.noCustomConfigForLibA/library.b/ui5-another-custom.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.3"
+type: library
+metadata:
+  name: library.b.another.custom