feat(project): Offer `configPath` property to workspace configs (`workspace/1.1`) by maxreichmann · Pull Request #1643 · UI5/cli

maxreichmann · 2026-10-08T14:17:35Z

This offers a configPath property to workspace dependency resolution entries as follows:

specVersion: workspace/1.1                      # new specVersion
metadata:
    name: default
dependencyManagement:
    resolutions:
        - path: ../test.library
          configPath: custom-config.yaml        # new customizable paths

(Introducing new specVersion workspace/1.1)

Other sub features:

Improve error handling when path is absolute
Improve error handling when multiple resolutions for the same dependency exist (by path property)
Forbid absolute paths for configPath
Allow relative paths for configPath (for path it's already allowed)
Fix pre-existing trailing-slash bug

The workspace resolution logic is now explicitly implemented as "Most specific wins" (the resolution entry with the deepest path gets precedence). Entries are sequentially processed while keeping file reads, glob expansion, and traversal within each entry async.

Closes: #1369
JIRA: CPOUI5FOUNDATION-1233

maxreichmann · 2026-10-09T07:26:50Z

Kindly asking @KlattG to review the documentation part of this PR already (Workspace.md).

(I didn't add this feature to the usual migrate-v5.md because we planned to downport to v4 too)

KlattG

LGTM

d3xter666

Please, check the log when you try to build with this new validation/schema:

strict mode: missing type "object" for keyword "properties" at "ui5-workspace.json#/then/properties/dependencyManagement" (strictTypes)
strict mode: missing type "array" for keyword "items" at "ui5-workspace.json#/then/properties/dependencyManagement/properties/resolutions" (strictTypes)
strict mode: missing type "object" for keyword "required" at "ui5-workspace.json#/then/properties/dependencyManagement/properties/resolutions/items/then/not" (strictTypes)

This is from AJV's strict mode

maxreichmann · 2026-10-13T13:27:25Z

Please, check the log when you try to build with this new validation/schema:

strict mode: missing type "object" for keyword "properties" at "ui5-workspace.json#/then/properties/dependencyManagement" (strictTypes)
strict mode: missing type "array" for keyword "items" at "ui5-workspace.json#/then/properties/dependencyManagement/properties/resolutions" (strictTypes)
strict mode: missing type "object" for keyword "required" at "ui5-workspace.json#/then/properties/dependencyManagement/properties/resolutions/items/then/not" (strictTypes)

This is from AJV's strict mode

Resolved with 4ebdb73

…plicat"

Implements the previously created concept markdown for "specificity wins + Error on duplicate"

NodePackageDependencies silently ignored the `configPath` of a workspace-resolved dependency. It's now carried through to projectGraphBuilder so the custom config is loaded instead of the default ui5.yaml.

When a workspace declares a resolution for a collection and a more specific one for a nested sub-collection or library inside it, the nested resolution must own its subtree's configPath. Which one applied depended on the order the async traversals finished: first to mark a node visited won. For members reached via recursion that order is I/O dependent, so a broader resolution could claim a module meant for a more specific one. Record the declared resolution roots up front and skip recursion into any member that is itself a declared resolution, leaving it and its subtree to that resolution.

Resolve workspace entries one at a time and track visited paths per resolution to prevent cycles. Preserve the most specific configuration when workspace globs overlap.

Treat paths with and without trailing slashes as the same directory, so overlapping resolutions load only the most specific config. + Add tests

maxreichmann · 2026-11-10T16:19:06Z

Kindly asking @KlattG to review the newest added docu part (d80a8ab)

Both issues fixed

maxreichmann · 2026-11-11T13:43:39Z

As this PR is quite huge, this review order might ease the start:

ui5-workspace.json: new specVersion and the actual configPath parameter (which only works for this new specVersion)
Workspace.js: Most of the logic: using configPath in the module collection; (also new: explicit "most specific wins" logic)
Module.js: exposing configPath by a getter
NodePackageDependencies.js: forwarding this exposed configPath to the creation of the ProjectGraph
Tests

The many new files under ./package/project/test are mostly just fixtures necessary for the new tests which represent file structures (nested workspaces with custom configs).
Here's the structure in case you'll need it:

Fixture: collection.c

Located under packages/project/test/fixtures/.
Every library also contains package.json, ui5.yaml, ui5-another-custom.yaml and it's source.

collection.c/
├── package.json
├── library.a/
│   └── ui5-custom.yaml
├── library.b/
│   └── ui5-custom.yaml
└── collection.a/
    ├── package.json
    ├── library.c/
    │   └── ui5-custom.yaml
    └── library.d/
        └── ui5-custom.yaml

Fixture: collection.c.noCustomConfigForLibA

Located under packages/project/test/fixtures/.
Every library also contains package.json, ui5.yaml, ui5-another-custom.yaml and it's source.

collection.c.noCustomConfigForLibA/
├── package.json
├── library.a/                 (ui5-custom.yaml intentionally absent)
├── library.b/
│   └── ui5-custom.yaml
└── collection.a/
    ├── package.json
    ├── library.c/
    │   └── ui5-custom.yaml
    └── library.d/
        └── ui5-custom.yaml

The added tests mostly test if the correct config was loaded in various scenarios.

codeworrior · 2026-11-11T15:00:53Z

-			log.verbose(`Module located at ${nodePath} has already been visited`);
-			return [];
+	async _getModulesFromPath(
+		visitedNodesPerResolution,


[suggestion only] you could make visitedNodesPerResolution the last parameter and give it a default of new Set(). The recursive call in lines 282-283 would propagate the parameter to nested calls. The call on top level (line 180) would not provide a value (-> the default applies).

That way, this helper collection would be fully local to _getModulesFromPath and not be spread over two levels.

codeworrior · 2026-11-11T15:06:46Z

+			const absolutePath = path.resolve(this.#cwd, resolutionPath);
+			if (seenAbsolutePaths.includes(absolutePath)) {
+				throw new Error(
+					`Multiple resolutions for the same dependency '${path.basename(absolutePath)}' ` +


[suggestion only] I find the term dependency misleading / confusing. A resolution path is not necessarily the same as a dependency in the sense of the ui5.yaml. It might e.g. point to the openui5 repository as a whole, covering multiple dependencies.

Suggestion: "Two resolutions in workspace '${this.getName()}' point to the same folder: ${resolutionPath} and ${earlierResolutionPath}"

To be able to name the earlier resolution path, the bookkeeping seenAbsolutePaths would have to be changed maybe to a map (key: absolute path; value: original resolutionPath).

But again, only a suggestion :-)

but what about more than two duplicate resolution paths? I would suggest:

"Two or more resolutions for '${path.basename(absolutePath)}' point to the same folder '${absolutePath}' in workspace '${this.getName()}'"

I guess, you also want to provide the full resolutionPath (what is written in the yaml)? Then we'd need to do some bookkeeping

Your text proposal is acceptable. And yes, I thought that naming the original resolution path(s) would be helpful to the developer.

…ocal)

devtomtom

Overall it looks good to me.

devtomtom · 2026-11-11T15:14:03Z

 # UI5 Workspaces

 ::: info
 **UI5 Workspaces is a new feature available since UI5 CLI [`v3.0.0`](https://github.com/SAP/ui5-cli/releases/tag/v3.0.0)** 


IMO we can get rid of the info and let the documentation start with the General Concept section

maxreichmann changed the title ~~Offer configPath property to workspace yamls (workspace/1.1)~~ feat(project): Offer configPath property to workspace yamls (workspace/1.1) Oct 8, 2026

maxreichmann changed the title ~~feat(project): Offer configPath property to workspace yamls (workspace/1.1)~~ feat(project): Offer configPath property to workspace configs (workspace/1.1) Oct 8, 2026

maxreichmann marked this pull request as draft October 8, 2026 14:21

maxreichmann commented Oct 12, 2026

View reviewed changes

Comment thread packages/project/lib/graph/Workspace.js Resolved

KlattG previously approved these changes Oct 12, 2026

View reviewed changes

maxreichmann dismissed KlattG’s stale review via df81a13 October 12, 2026 13:28

maxreichmann force-pushed the offer-configPath-to-workspace-yaml branch 8 times, most recently from 398ace8 to 5c857ed Compare October 12, 2026 15:42

maxreichmann marked this pull request as ready for review October 12, 2026 16:07

maxreichmann requested a review from a team October 12, 2026 16:07

d3xter666 requested changes Oct 13, 2026

View reviewed changes

Comment thread packages/project/lib/validation/schema/ui5-workspace.json Resolved

This was referenced Oct 13, 2026

[INTERNAL] Document configPath property #1662

Draft

[FEATURE] Offer configPath property to workspace configs (workspace/1.1) SAP/ui5-project#902

Draft

d3xter666 previously requested changes Oct 14, 2026

View reviewed changes

Comment thread packages/project/lib/validation/schema/ui5-workspace.json Resolved

Comment thread packages/project/lib/graph/Workspace.js Resolved

maxreichmann marked this pull request as draft October 15, 2026 14:42

maxreichmann force-pushed the offer-configPath-to-workspace-yaml branch 6 times, most recently from b5f28b4 to 2a27fc6 Compare October 20, 2026 14:32

maxreichmann force-pushed the offer-configPath-to-workspace-yaml branch from adf732b to 6e7dcd2 Compare October 27, 2026 17:29

maxreichmann and others added 14 commits November 10, 2026 17:02

test: Add concept markdown for logic "specific one wins + error on du…

560c97b

…plicat"

refactor: Add error handling for duplicate assignments

fafe13d

Implements the previously created concept markdown for "specificity wins + Error on duplicate"

test(project): Fix stale tests

fd4f722

refactor: Only throw double resolutions if same absolute path

b9d5595

test(project): Fix windows paths

8c98055

test(project): Cleanup

133d63c

docs: Fix path resolution

2d466cd

test: Fix path for error message

0c0a472

fix(project): Forward workspace configPath to the project graph

236c5f5

NodePackageDependencies silently ignored the `configPath` of a workspace-resolved dependency. It's now carried through to projectGraphBuilder so the custom config is loaded instead of the default ui5.yaml.

fix(project): Fix specificity of workspace config resolution

5eb9557

test(project): Add cases for overlapping workspace globs

2bbcfab

fix(project): Process workspace resolutions sequentially

5fe1f21

Resolve workspace entries one at a time and track visited paths per resolution to prevent cycles. Preserve the most specific configuration when workspace globs overlap.

fix(project): Normalize workspace paths with trailing slashes

d3b7fb4

Treat paths with and without trailing slashes as the same directory, so overlapping resolutions load only the most specific config. + Add tests

maxreichmann force-pushed the offer-configPath-to-workspace-yaml branch from 51acda3 to d3b7fb4 Compare November 10, 2026 16:02

refactor: Rebase (+fix merge conflicts)

75f8e5e

maxreichmann force-pushed the offer-configPath-to-workspace-yaml branch from b4ee83b to 75f8e5e Compare November 10, 2026 16:08

docs: Add docu for "Most specific wins" logic

d80a8ab

docs: Refactor to "tip" element

5de6920

KlattG previously approved these changes Nov 11, 2026

View reviewed changes

test(project): Add two cases for dynamic workspace globs

88fc20b

maxreichmann dismissed KlattG’s stale review via 88fc20b November 11, 2026 12:51

maxreichmann marked this pull request as ready for review November 11, 2026 13:44

maxreichmann requested a review from a team November 11, 2026 13:44

codeworrior reviewed Nov 11, 2026

View reviewed changes

refactor: Apply @codeworrior suggestion (make helper variable fully l…

7e3727f

…ocal)

devtomtom approved these changes Nov 11, 2026

View reviewed changes

Conversation

maxreichmann commented Oct 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maxreichmann commented Oct 9, 2026

Uh oh!

Uh oh!

KlattG left a comment

Choose a reason for hiding this comment

Uh oh!

d3xter666 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

maxreichmann commented Oct 13, 2026

Uh oh!

Uh oh!

Uh oh!

maxreichmann commented Nov 10, 2026

Uh oh!

maxreichmann commented Nov 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codeworrior Nov 11, 2026

Choose a reason for hiding this comment

Uh oh!

codeworrior Nov 11, 2026

Choose a reason for hiding this comment

Uh oh!

maxreichmann Nov 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codeworrior Nov 11, 2026

Choose a reason for hiding this comment

Uh oh!

devtomtom left a comment

Choose a reason for hiding this comment

Uh oh!

devtomtom Nov 11, 2026

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

maxreichmann commented Oct 8, 2026 •

edited

Loading

maxreichmann commented Nov 11, 2026 •

edited

Loading

maxreichmann Nov 11, 2026 •

edited

Loading