[INTERNAL] ui5-workspace.yaml schema

lib/graph/Module.js

@@ -351,7 +351,8 @@ class Module {
 							path: configPath,
 							source: configFile,
 							documentIndex
-						}
+						},
+						schemaName: "ui5.json"
 					});
 				} catch (error) {
 					return error;

lib/specifications/Specification.js

@@ -112,7 +112,8 @@ class Specification {
 					config,
 					project: {
 						id
-					}
+					},
+					schemaName: "ui5.json"
 				});
 			} catch (err) {
 				this._log.verbose(
@@ -130,7 +131,8 @@ class Specification {
 				config,
 				project: {
 					id
-				}
+				},
+				schemaName: "ui5.json"
 			});
 		}
 

lib/validation/ValidationError.js

@@ -49,7 +49,7 @@ class ValidationError extends Error {
 			separator += chalk.grey.dim("\u2500".repeat(process.stdout.columns || 80));
 		}
 		separator += "\n\n";
-		let message = chalk.red(`Invalid ui5.yaml configuration for project ${this.project.id}`) + "\n\n";
+		let message = chalk.red(`Invalid configuration for project ${this.project.id}`) + "\n\n";
 		message += this.errors.map((error) => {
 			return this.formatError(error);
 		}).join(separator);

lib/validation/schema/ui5-workspace.json

@@ -0,0 +1,54 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema",
+	"$id": "http://ui5.sap/schema/ui5-workspace.json",
+	"title": "ui5-workspace.yaml",
+	"description": "Schema for UI5 Tooling Workspace Configuration File (ui5-workspace.yaml)",
+	"$comment": "See https://sap.github.io/ui5-tooling/",
+	"type": "object",
+	"required": ["specVersion", "metadata", "dependencyManagement"],
+	"properties": {
+		"additionalProperties": false,
+		"specVersion": {
+			"enum": ["workspace/1.0"],
+			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"workspace/1.0\"\nFor details see: // TODO: Add link to Documentation"
+		},
+		"metadata": {
+			"$ref": "#/definitions/metadata"
+		},
+		"dependencyManagement": {
+			"$ref": "#/definitions/dependencyManagement"
+		}
+	},
+	"definitions": {
+		"metadata": {
+			"type": "object",
+			"required": ["name"],
+			"properties": {
+				"additionalProperties": false,
+				"name": {
+					"type": "string",
+					"errorMessage": "Workspace name is not provided. There must be a wokrspace name defined."
+				}
+			}
+		},
+		"dependencyManagement": {
+			"type": "object",
+			"properties": {
+				"additionalProperties": false,
+				"resolutions": {
+					"type": "array",
+					"additionalProperties": false,
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"properties": {
+							"path": {
+								"type": "string"
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}

lib/validation/validator.js

@@ -1,37 +1,33 @@
 import {fileURLToPath} from "node:url";
 import {readFile} from "node:fs/promises";
 
-async function loadSchema(schemaPath) {
-	const filePath = schemaPath.replace("http://ui5.sap/schema/", "");
-	const schemaFile = await readFile(
-		fileURLToPath(new URL(`./schema/${filePath}`, import.meta.url)), {encoding: "utf8"}
-	);
-	return JSON.parse(schemaFile);
-}
-
 class Validator {
 	constructor({Ajv, ajvErrors}) {
 		this.ajv = new Ajv({
 			allErrors: true,
 			jsonPointers: true,
-			loadSchema
+			loadSchema: Validator.loadSchema
 		});
 		ajvErrors(this.ajv);
 	}
 
-	_compileSchema() {
+	_compileSchema(schemaName) {
+		if (!schemaName) {
+			throw new Error("Schema is missing. Schema name must be provided");
+		}
+
 		if (!this._compiling) {
 			this._compiling = Promise.resolve().then(async () => {
-				const schema = await loadSchema("ui5.json");
+				const schema = await Validator.loadSchema(schemaName);
 				const validate = await this.ajv.compileAsync(schema);
 				return validate;
 			});
 		}
 		return this._compiling;
 	}
 
-	async validate({config, project, yaml}) {
-		const fnValidate = await this._compileSchema();
+	async validate({config, project, yaml, schemaName}) {
+		const fnValidate = await this._compileSchema(schemaName);
 		const valid = fnValidate(config);
 		if (!valid) {
 			// Read errors/schema from fnValidate before lazy loading ValidationError module.
@@ -46,6 +42,14 @@ class Validator {
 			});
 		}
 	}
+
+	static async loadSchema(schemaPath) {
+		const filePath = schemaPath.replace("http://ui5.sap/schema/", "");
+		const schemaFile = await readFile(
+			fileURLToPath(new URL(`./schema/${filePath}`, import.meta.url)), {encoding: "utf8"}
+		);
+		return JSON.parse(schemaFile);
+	}
 }
 
 let validator;

test/lib/graph/Module.js

@@ -372,7 +372,7 @@ test("Invalid configuration in file", async (t) => {
 	});
 	const err = await t.throwsAsync(ui5Module.getSpecifications());
 
-	t.true(err.message.includes("Invalid ui5.yaml configuration"), "Threw with validation error");
+	t.true(err.message.includes("Invalid configuration"), "Threw with validation error");
 	// Check that config file name is referenced. This validates that the error was not produced by
 	// the Specification instance but the Module
 	t.true(err.message.includes("ui5-test-error.yaml"), "Error message references file name");

test/lib/specifications/Project.js

@@ -31,7 +31,7 @@ test("Invalid configuration", async (t) => {
 		}
 	};
 	const error = await t.throwsAsync(Specification.create(customProjectInput));
-	t.is(error.message, `${chalk.red("Invalid ui5.yaml configuration for project application.a.id")}
+	t.is(error.message, `${chalk.red("Invalid configuration for project application.a.id")}
 
 Configuration \
 ${chalk.underline(chalk.red("resources/configuration/propertiesFileSourceEncoding"))} \

test/lib/validation/ValidationError.js

@@ -201,7 +201,7 @@ test.serial("ValidationError.formatErrors", (t) => {
 	const message = ValidationError.prototype.formatErrors.apply(fakeValidationErrorInstance);
 
 	const expectedMessage =
-`${chalk.red("Invalid ui5.yaml configuration for project my-project")}
+`${chalk.red("Invalid configuration for project my-project")}
 
 Error message 1
 

test/lib/validation/schema/specVersion/kind/extension.js

@@ -6,7 +6,7 @@ import {_Validator as Validator} from "../../../../../../lib/validation/validato
 import ValidationError from "../../../../../../lib/validation/ValidationError.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/extension/project-shim.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import extension from "../../../__helper__/extension.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/extension/server-middleware.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import extension from "../../../__helper__/extension.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/extension/task.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import extension from "../../../__helper__/extension.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/project.js

@@ -6,7 +6,7 @@ import {_Validator as Validator} from "../../../../../../lib/validation/validato
 import ValidationError from "../../../../../../lib/validation/ValidationError.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/project/application.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import project from "../../../__helper__/project.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/project/library.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import project from "../../../__helper__/project.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/project/module.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import project from "../../../__helper__/project.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,

test/lib/validation/schema/specVersion/kind/project/theme-library.js

@@ -7,7 +7,7 @@ import ValidationError from "../../../../../../../lib/validation/ValidationError
 import project from "../../../__helper__/project.js";
 
 async function assertValidation(t, config, expectedErrors = undefined) {
-	const validation = t.context.validator.validate({config, project: {id: "my-project"}});
+	const validation = t.context.validator.validate({config, project: {id: "my-project"}, schemaName: "ui5.json"});
 	if (expectedErrors) {
 		const validationError = await t.throwsAsync(validation, {
 			instanceOf: ValidationError,