[INTERNAL] Adopt ui5-project changes III

Author: RandomByte

lib/tasks/TaskUtil.js

@@ -1,5 +1,3 @@
-const ProjectResource = require("@ui5/fs").ProjectResource;
-
 /**
  * Convenience functions for UI5 Builder tasks.
  * An instance of this class is passed to every standard UI5 Builder task that requires it.
@@ -37,11 +35,20 @@ class TaskUtil {
 	constructor({projectBuildContext}) {
 		this._projectBuildContext = projectBuildContext;
 
+		this.GLOBAL_TAGS = Object.freeze({
+			IsDebugVariant: "ui5:IsDebugVariant",
+			HasDebugVariant: "ui5:HasDebugVariant"
+		});
+
 		/**
 		 * @member {module:@ui5/builder.tasks.TaskUtil~StandardBuildTags}
 		 * @public
 		*/
-		this.STANDARD_TAGS = this._projectBuildContext.STANDARD_TAGS;
+		this.STANDARD_TAGS = Object.freeze({
+			OmitFromBuildResult: "ui5:OmitFromBuildResult",
+			IsBundle: "ui5:IsBundle",
+			...this.GLOBAL_TAGS
+		});
 	}
 
 	/**
@@ -53,26 +60,20 @@ class TaskUtil {
 	 * This method is only available to custom task extensions defining
 	 * <b>Specification Version 2.2 and above</b>.
 	 *
-	 * @param {module:@ui5/fs.ProjectResource} resource Resource-instance the tag should be stored for
+	 * @param {module:@ui5/fs.Resource} resource Resource-instance the tag should be stored for
 	 * @param {string} tag Name of the tag.
 	 * 		Currently only the [STANDARD_TAGS]{@link module:@ui5/builder.tasks.TaskUtil#STANDARD_TAGS} are allowed
 	 * @param {string|boolean|integer} [value=true] Tag value. Must be primitive
 	 * @public
 	 */
 	setTag(resource, tag, value) {
 		if (typeof resource === "string") {
-			throw new Error("TODO 3.0: Deprecated");
-		}
-		if (!(resource instanceof ProjectResource)) {
-			throw new Error("Resource must be an instance of ProjectResource");
+			throw new Error("Deprecated parameter: " +
+				"Since UI5 Tooling 3.0, setTag requires a resource instance. Strings are no longer accepted");
 		}
-		const project = resource.getProject();
-		if (project !== this._projectBuildContext.getProject()) {
-			throw new Error(
-				`Unable to set tag for project ${project.getName()} ` +
-				`while building project ${this._projectBuildContext.getProject().getName()}`);
-		}
-		return project.setTag(resource.getPath(), tag, value);
+
+		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
+		return collection.setTag(resource.getPath(), tag, value);
 	}
 
 	/**
@@ -82,20 +83,19 @@ class TaskUtil {
 	 * This method is only available to custom task extensions defining
 	 * <b>Specification Version 2.2 and above</b>.
 	 *
-	 * @param {module:@ui5/fs.ProjectResource} resource Resource-instance the tag should be retrieved for
+	 * @param {module:@ui5/fs.Resource} resource Resource-instance the tag should be retrieved for
 	 * @param {string} tag Name of the tag
 	 * @returns {string|boolean|integer|undefined} Tag value for the given resource.
 	 * 										<code>undefined</code> if no value is available
 	 * @public
 	 */
 	getTag(resource, tag) {
 		if (typeof resource === "string") {
-			throw new Error("TODO 3.0: Deprecated");
-		}
-		if (!(resource instanceof ProjectResource)) {
-			throw new Error("Resource must be an instance of ProjectResource");
+			throw new Error("Deprecated parameter: " +
+				"Since UI5 Tooling 3.0, getTag requires a resource instance. Strings are no longer accepted");
 		}
-		return resource.getProject().getTag(resource.getPath(), tag);
+		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
+		return collection.getTag(resource.getPath(), tag);
 	}
 
 	/**
@@ -106,18 +106,17 @@ class TaskUtil {
 	 * This method is only available to custom task extensions defining
 	 * <b>Specification Version 2.2 and above</b>.
 	 *
-	 * @param {module:@ui5/fs.ProjectResource} resource Resource-instance the tag should be cleared for
+	 * @param {module:@ui5/fs.Resource} resource Resource-instance the tag should be cleared for
 	 * @param {string} tag Tag
 	 * @public
 	 */
 	clearTag(resource, tag) {
 		if (typeof resource === "string") {
-			throw new Error("TODO 3.0: Deprecated");
+			throw new Error("Deprecated parameter: " +
+				"Since UI5 Tooling 3.0, clearTag requires a resource instance. Strings are no longer accepted");
 		}
-		if (!(resource instanceof ProjectResource)) {
-			throw new Error("Resource must be an instance of ProjectResource");
-		}
-		return resource.getProject().clearTag(resource.getPath(), tag);
+		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
+		return collection.clearTag(resource.getPath(), tag);
 	}
 
 	/**
@@ -174,6 +173,18 @@ class TaskUtil {
 		return this._projectBuildContext.getProject(projectName);
 	}
 
+	createResource(parameters) {
+		if (!parameters.project) {
+			parameters.project = this.getProject();
+		}
+		const Resource = require("@ui5/fs").Resource;
+		return new Resource(parameters);
+	}
+
+	getCreateResourceFn() {
+		return this.createResource.bind(this);
+	}
+
 	/**
 	 * 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.

lib/tasks/bundlers/utils/createModuleNameMapping.js

@@ -17,8 +17,9 @@ const ModuleName = require("../../../lbt/utils/ModuleName");
 module.exports = function({resources, taskUtil}) {
 	const moduleNameMapping = {};
 	for (let i = resources.length - 1; i >= 0; i--) {
-		const resourcePath = resources[i].getPath();
-		if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
+		const resource = resources[i];
+		if (taskUtil.getTag(resource, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
+			const resourcePath = resource.getPath();
 			const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
 			if (!nonDbgPath) {
 				throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);

lib/tasks/generateCachebusterInfo.js

@@ -35,13 +35,12 @@ function getSigner(type) {
  * @alias module:@ui5/builder.tasks.generateCachebusterInfo
  * @param {object} parameters Parameters
  * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
- * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.namespace Namespace of the application
  * @param {string} [parameters.options.signatureType='time'] Type of signature to be used ('time' or 'hash')
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, dependencies, options: {namespace, signatureType}}) {
+module.exports = function({workspace, options: {namespace, signatureType}}) {
 	const basePath = `/resources/${namespace}/`;
 	return workspace.byGlob(`/resources/${namespace}/**/*`)
 		.then(async (resources) => {