[FEATURE] Add specVersion 3.1 and builder resource excludes for modules (#639)

Based on #623 but with the
component type removed again.

JIRA: CPOUI5FOUNDATION-561

---------

Co-authored-by: Florian Vogt <[email protected]>

Author: RandomByte

lib/specifications/SpecificationVersion.js

@@ -4,7 +4,7 @@ const SPEC_VERSION_PATTERN = /^\d+\.\d+$/;
 const SUPPORTED_VERSIONS = [
 	"0.1", "1.0", "1.1",
 	"2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6",
-	"3.0"
+	"3.0", "3.1"
 ];
 
 /**
@@ -63,8 +63,8 @@ class SpecificationVersion {
 	 * Test whether the instance's Specification Version falls into the provided range
 	 *
 	 * @public
-@param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
-for example <code>2.2 - 2.4</code>
+	 * @param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
+	 * for example <code>2.2 - 2.4</code> or <code>=3.0</code>
 	 * @returns {boolean} True if the instance's Specification Version falls into the provided range
 	 */
 	satisfies(range) {
@@ -263,6 +263,22 @@ for example <code>2.2 - 2.4</code>
 		const comparator = new SpecificationVersion(specVersion);
 		return comparator.neq(testVersion);
 	}
+
+	/**
+	 * Creates an array of Specification Versions that match with the provided range. This is mainly used
+	 * for testing purposes. I.e. to execute identical tests for a range of specification versions.
+	 *
+	 * @public
+	 * @param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
+	 * for example <code>2.2 - 2.4</code> or <code>=3.0</code>
+	 * @returns {string[]} Array of versions that match the specified range
+	 */
+	static getVersionsForRange(range) {
+		return SUPPORTED_VERSIONS.filter((specVersion) => {
+			const comparator = new SpecificationVersion(specVersion);
+			return comparator.satisfies(range);
+		});
+	}
 }
 
 function getUnsupportedSpecVersionMessage(specVersion) {

lib/specifications/types/Application.js

@@ -66,11 +66,17 @@ class Application extends ComponentProject {
 		return null; // Applications do not have a dedicated test directory
 	}
 
+	/**
+	 * Get a resource reader for the sources of the project (excluding any test resources)
+	 * without a virtual base path
+	 *
+	 * @returns {@ui5/fs/ReaderCollection} Reader collection
+	*/
 	_getRawSourceReader() {
 		return createReader({
 			fsBasePath: this.getSourcePath(),
 			virBasePath: "/",
-			name: `Source reader for application project ${this.getName()}`,
+			name: `Raw source reader for application project ${this.getName()}`,
 			project: this
 		});
 	}

lib/specifications/types/Library.js

@@ -107,17 +107,18 @@ class Library extends ComponentProject {
 	}
 
 	/**
-	 *
 	 * Get a resource reader for the sources of the project (excluding any test resources)
+	 * without a virtual base path.
 	 * In the future the path structure can be flat or namespaced depending on the project
+	 * setup
 	 *
 	 * @returns {@ui5/fs/ReaderCollection} Reader collection
 	*/
 	_getRawSourceReader() {
 		return resourceFactory.createReader({
 			fsBasePath: this.getSourcePath(),
 			virBasePath: "/",
-			name: `Source reader for library project ${this.getName()}`,
+			name: `Raw source reader for library project ${this.getName()}`,
 			project: this
 		});
 	}

lib/validation/schema/specVersion/kind/extension.json

@@ -5,7 +5,7 @@
 	"type": "object",
 	"required": ["specVersion", "kind", "type", "metadata"],
 	"properties": {
-		"specVersion": { "enum": ["3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
+		"specVersion": { "enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
 		"kind": {
 			"enum": ["extension"]
 		},

lib/validation/schema/specVersion/kind/extension/project-shim.json

@@ -6,14 +6,14 @@
 	"required": ["specVersion", "kind", "type", "metadata", "shims"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["3.0"] }
+			"specVersion": { "enum": ["3.0", "3.1"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
 			"specVersion": {
-				"enum": ["3.0"]
+				"enum": ["3.0", "3.1"]
 			},
 			"kind": {
 				"enum": ["extension"]

lib/validation/schema/specVersion/kind/extension/server-middleware.json

@@ -7,13 +7,13 @@
 	"required": ["specVersion", "kind", "type", "metadata", "middleware"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["3.0"] }
+			"specVersion": { "enum": ["3.0", "3.1"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["3.0"] },
+			"specVersion": { "enum": ["3.0", "3.1"] },
 			"kind": {
 				"enum": ["extension"]
 			},

lib/validation/schema/specVersion/kind/extension/task.json

@@ -6,13 +6,13 @@
 	"required": ["specVersion", "kind", "type", "metadata", "task"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["3.0"] }
+			"specVersion": { "enum": ["3.0", "3.1"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["3.0"] },
+			"specVersion": { "enum": ["3.0", "3.1"] },
 			"kind": {
 				"enum": ["extension"]
 			},

lib/validation/schema/specVersion/kind/project.json

@@ -5,7 +5,7 @@
 	"type": "object",
 	"required": ["specVersion", "type"],
 	"properties": {
-		"specVersion": { "enum": ["3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
+		"specVersion": { "enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"] },
 		"kind": {
 			"enum": ["project", null],
 			"$comment": "Using null to allow not defining 'kind' which defaults to project"
@@ -19,6 +19,7 @@
 			]
 		}
 	},
+
 	"if": {
 		"properties": {
 			"type": {"const": null}

lib/validation/schema/specVersion/kind/project/application.json

@@ -6,13 +6,13 @@
 	"required": ["specVersion", "type", "metadata"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["3.0"] }
+			"specVersion": { "enum": ["3.0", "3.1"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["3.0"] },
+			"specVersion": { "enum": ["3.0", "3.1"] },
 			"kind": {
 				"enum": ["project", null]
 			},

lib/validation/schema/specVersion/kind/project/library.json

@@ -6,13 +6,13 @@
 	"required": ["specVersion", "type", "metadata"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["3.0"] }
+			"specVersion": { "enum": ["3.0", "3.1"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["3.0"] },
+			"specVersion": { "enum": ["3.0", "3.1"] },
 			"kind": {
 				"enum": ["project", null]
 			},