[FEATURE] Introduce SpecificationVersion class

lib/build/TaskRunner.js

@@ -309,12 +309,13 @@ class TaskRunner {
  params.dependencies = dependencies;
  }
 
- if (task.getSpecVersion() === "3.0") {
+ const specVersion = task.getSpecVersionComparator();
+ if (specVersion.gte("3.0")) {
  params.options.taskName = newTaskName;
  params.log = logger.getGroupLogger(`builder:custom-task:${newTaskName}`);
  }
 
- const taskUtilInterface = taskUtil.getInterface(task.getSpecVersion());
+ const taskUtilInterface = taskUtil.getInterface(specVersion);
  // Interface is undefined if specVersion does not support taskUtil
  if (taskUtilInterface) {
  params.taskUtil = taskUtilInterface;

lib/build/helpers/TaskUtil.js

@@ -269,11 +269,13 @@ class TaskUtil {
  * Get an interface to an instance of this class that only provides those functions
  * that are supported by the given custom task extension specification version.
  *
- * @param {string} specVersion Specification version of custom task extension
+ * @param {@ui5/project/specifications/utils/SpecVersionComparator} specVersion
+ * SpecVersionComparator instance of the custom task
  * @returns {object} An object with bound instance methods supported by the given specification version
  */
  getInterface(specVersion) {
- if (["0.1", "1.0", "1.1", "2.0", "2.1"].includes(specVersion)) {
+ if (specVersion.lte("2.1")) {
+ // Tasks defining specVersion <= 2.1 do not have access to any TaskUtil APIs
  return undefined;
  }
 
@@ -283,14 +285,8 @@ class TaskUtil {
  bindFunctions(this, baseInterface, [
  "setTag", "clearTag", "getTag", "isRootProject", "registerCleanupTask"
  ]);
- switch (specVersion) {
- case "2.2":
- case "2.3":
- case "2.4":
- case "2.5":
- case "2.6":
- return baseInterface;
- case "3.0":
+
+ if (specVersion.gte("3.0")) {
  // getProject function, returning an interfaced project instance
  baseInterface.getProject = (projectName) => {
  const project = this.getProject(projectName);
@@ -299,10 +295,7 @@ class TaskUtil {
  "getSpecVersion", "getType", "getName", "getVersion", "getNamespace",
  "getRootReader", "getReader", "getCustomConfiguration", "isFrameworkProject"
  ]);
- switch (specVersion) {
- case "3.0":
- return baseProjectInterface;
- }
+ return baseProjectInterface;
  };
  // getDependencies function, returning an array of project names
  baseInterface.getDependencies = (projectName) => {
@@ -318,11 +311,8 @@ class TaskUtil {
  ].forEach((factoryFunction) => {
  baseInterface.resourceFactory[factoryFunction] = this.resourceFactory[factoryFunction];
  });
-
- return baseInterface;
- default:
- throw new Error(`TaskUtil: Unknown or unsupported Specification Version ${specVersion}`);
  }
+ return baseInterface;
  }
 }
 

lib/specifications/Specification.js

@@ -1,5 +1,6 @@
 import logger from "@ui5/logger";
 import {createReader} from "@ui5/fs/resourceFactory";
+import SpecVersionComparator from "./utils/SpecVersionComparator.js";
 
 /**
  * Abstract superclass for all projects and extensions
@@ -50,10 +51,9 @@ class Specification {
  const config = JSON.parse(JSON.stringify(configuration));
  const {validate} = await import("../validation/validator.js");
 
- if (config.specVersion === "0.1" || config.specVersion === "1.0" ||
- config.specVersion === "1.1") {
+ if (SpecVersionComparator.major(config.specVersion) <= 1) {
  const originalSpecVersion = config.specVersion;
- this._log.verbose(`Detected legacy specification version ${config.specVersion}, defined for ` +
+ this._log.verbose(`Detected legacy Specification Version ${config.specVersion}, defined for ` +
  `${config.kind} ${config.metadata.name}. ` +
  `Attempting to migrate the project to a supported specification version...`);
  this._migrateLegacyProject(config);
@@ -69,20 +69,12 @@ class Specification {
  `Validation error after migration of ${config.kind} ${config.metadata.name}:`);
  this._log.verbose(err.message);
  throw new Error(
- `${config.kind} ${config.metadata.name} defines unsupported specification version ` +
+ `${config.kind} ${config.metadata.name} defines unsupported Specification Version ` +
  `${originalSpecVersion}. Please manually upgrade to 2.0 or higher. ` +
  `For details see https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions - ` +
  `An attempted migration to a supported specification version failed, ` +
  `likely due to unrecognized configuration. Check verbose log for details.`);
  }
- } else if (config.specVersion !== "2.0" &&
- config.specVersion !== "2.1" && config.specVersion !== "2.2" &&
- config.specVersion !== "2.3" && config.specVersion !== "2.4" &&
- config.specVersion !== "2.5" && config.specVersion !== "2.6") {
- throw new Error(
- `Unsupported specification version ${config.specVersion} defined in ${config.kind} ` +
- `${config.metadata.name}. Your UI5 CLI installation might be outdated. ` +
- `For details see https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions`);
  } else {
  await validate({
  config,
@@ -151,6 +143,17 @@ class Specification {
  return this._specVersion;
  }
 
+ /**
+ * Returns an instance of a helper class allowing for convenient comparison
+ * operations against this instance's Specification Version
+ *
+ * @public
+ * @returns {@ui5/project/specifications/utils/SpecVersionComparator}
+ */
+ getSpecVersionComparator() {
+ return new SpecVersionComparator(this.getSpecVersion());
+ }
+
  /**
  * Get the specification's generic version, as typically defined in a <code>package.json</code>
  *