@ui5/builder 3.0.0-alpha.6 → 3.0.0-alpha.9

package/lib/tasks/TaskUtil.js

@@ -1,172 +0,0 @@
-/**
- * Convenience functions for UI5 Builder tasks.
- * An instance of this class is passed to every standard UI5 Builder task that requires it.
- *
- * Custom tasks that define a specification version >= 2.2 will receive an interface
- * to an instance of this class when called.
- * The set of available functions on that interface depends on the specification
- * version defined for the extension.
- *
- * @public
- * @memberof module:@ui5/builder.tasks
- */
-class TaskUtil {
-	/**
-	 * Standard Build Tags. See UI5 Tooling
-	 * [RFC 0008]{@link https://github.com/SAP/ui5-tooling/blob/master/rfcs/0008-resource-tagging-during-build.md}
-	 * for details.
-	 *
-	 * @public
-	 * @typedef {object} module:@ui5/builder.tasks.TaskUtil~StandardBuildTags
-	 * @property {string} OmitFromBuildResult
-	 * 		Setting this tag to true for a resource will prevent it from being written to the build target
-	 * @property {string} IsBundle
-	 * 		This tag identifies resources that contain (i.e. bundle) multiple other resources
-	 */
-
-	/**
-	 * Since <code>@ui5/builder.builder.ProjectBuildContext</code> is a private class, TaskUtil must not be
-	 * instantiated by modules other than @ui5/builder itself.
-	 *
-	 * @param {object} parameters
-	 * @param {module:@ui5/builder.builder.ProjectBuildContext} parameters.projectBuildContext ProjectBuildContext
-	 * @public
-	 */
-	constructor({projectBuildContext}) {
-		this._projectBuildContext = projectBuildContext;
-
-		/**
-		 * @member {module:@ui5/builder.tasks.TaskUtil~StandardBuildTags}
-		 * @public
-		*/
-		this.STANDARD_TAGS = this._projectBuildContext.STANDARD_TAGS;
-	}
-
-	/**
-	 * Stores a tag with value for a given resource's path. Note that the tag is independent of the supplied
-	 * resource instance. For two resource instances with the same path, the same tag value is returned.
-	 * If the path of a resource is changed, any tag information previously stored for that resource is lost.
-	 *
-	 * </br></br>
-	 * This method is only available to custom task extensions defining
-	 * <b>Specification Version 2.2 and above</b>.
-	 *
-	 * @param {string|module:@ui5/fs.Resource} resourcePath Path or 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(resourcePath, tag, value) {
-		return this._projectBuildContext.getResourceTagCollection().setTag(resourcePath, tag, value);
-	}
-
-	/**
-	 * Retrieves the value for a stored tag. If no value is stored, <code>undefined</code> is returned.
-	 *
-	 * </br></br>
-	 * This method is only available to custom task extensions defining
-	 * <b>Specification Version 2.2 and above</b>.
-	 *
-	 * @param {string|module:@ui5/fs.Resource} resourcePath Path or 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(resourcePath, tag) {
-		return this._projectBuildContext.getResourceTagCollection().getTag(resourcePath, tag);
-	}
-
-	/**
-	 * Clears the value of a tag stored for the given resource's path.
-	 * It's like the tag was never set for that resource.
-	 *
-	 * </br></br>
-	 * This method is only available to custom task extensions defining
-	 * <b>Specification Version 2.2 and above</b>.
-	 *
-	 * @param {string|module:@ui5/fs.Resource} resourcePath Path or resource-instance the tag should be cleared for
-	 * @param {string} tag Tag
-	 * @public
-	 */
-	clearTag(resourcePath, tag) {
-		return this._projectBuildContext.getResourceTagCollection().clearTag(resourcePath, tag);
-	}
-
-	/**
-	 * Check whether the project currently being built is the root project.
-	 *
-	 * </br></br>
-	 * This method is only available to custom task extensions defining
-	 * <b>Specification Version 2.2 and above</b>.
-	 *
-	 * @returns {boolean} <code>true</code> if the currently built project is the root project
-	 * @public
-	 */
-	isRootProject() {
-		return this._projectBuildContext.isRootProject();
-	}
-
-	/**
-	 * Retrieves a build option defined by its <code>key</code.
-	 * If no option with the given <code>key</code> is stored, <code>undefined</code> is returned.
-	 *
-	 * @param {string} key The option key
-	 * @returns {any|undefined} The build option (or undefined)
-	 * @private
-	 */
-	getBuildOption(key) {
-		return this._projectBuildContext.getOption(key);
-	}
-
-	/**
-	 * Register a function that must be executed once the build is finished. This can be used to, for example,
-	 * clean up files temporarily created on the file system. If the callback returns a Promise, it will be waited for.
-	 * It will also be executed in cases where the build has failed or has been aborted.
-	 *
-	 * </br></br>
-	 * This method is only available to custom task extensions defining
-	 * <b>Specification Version 2.2 and above</b>.
-	 *
-	 * @param {Function} callback Callback to register. If it returns a Promise, it will be waited for
-	 * @public
-	 */
-	registerCleanupTask(callback) {
-		return this._projectBuildContext.registerCleanupTask(callback);
-	}
-
-	/**
-	 * 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
-	 * @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)) {
-			return undefined;
-		}
-
-		const baseInterface = {
-			STANDARD_TAGS: this.STANDARD_TAGS,
-			setTag: this.setTag.bind(this),
-			clearTag: this.clearTag.bind(this),
-			getTag: this.getTag.bind(this),
-			isRootProject: this.isRootProject.bind(this),
-			registerCleanupTask: this.registerCleanupTask.bind(this)
-		};
-		switch (specVersion) {
-		case "2.2":
-		case "2.3":
-		case "2.4":
-		case "2.5":
-		case "2.6":
-			return baseInterface;
-		default:
-			throw new Error(`TaskUtil: Unknown or unsupported Specification Version ${specVersion}`);
-		}
-	}
-}
-
-module.exports = TaskUtil;

package/lib/types/AbstractBuilder.js

@@ -1,270 +0,0 @@
-
-/**
- * Resource collections
- *
- * @public
- * @typedef module:@ui5/builder.BuilderResourceCollections
- * @property {module:@ui5/fs.DuplexCollection} workspace Workspace Resource
- * @property {module:@ui5/fs.ReaderCollection} dependencies Workspace Resource
- */
-
-/**
- * Base class for the builder implementation of a project type
- *
- * @abstract
- */
-class AbstractBuilder {
-	/**
-	 * Constructor
-	 *
-	 * @param {object} parameters
-	 * @param {BuilderResourceCollections} parameters.resourceCollections Resource collections
-	 * @param {object} parameters.project Project configuration
-	 * @param {GroupLogger} parameters.parentLogger Logger to use
-	 * @param {object} parameters.taskUtil
-	 */
-	constructor({resourceCollections, project, parentLogger, taskUtil}) {
-		if (new.target === AbstractBuilder) {
-			throw new TypeError("Class 'AbstractBuilder' is abstract");
-		}
-
-		this.project = project;
-
-		this.log = parentLogger.createSubLogger(project.type + " " + project.metadata.name, 0.2);
-		this.taskLog = this.log.createTaskLogger("🔨");
-
-		this.tasks = {};
-		this.taskExecutionOrder = [];
-		this.addStandardTasks({
-			resourceCollections,
-			project,
-			log: this.log,
-			taskUtil
-		});
-		this.addCustomTasks({
-			resourceCollections,
-			project,
-			taskUtil
-		});
-	}
-
-	/**
-	 * Adds all standard tasks to execute
-	 *
-	 * @abstract
-	 * @protected
-	 * @param {object} parameters
-	 * @param {BuilderResourceCollections} parameters.resourceCollections Resource collections
-	 * @param {object} parameters.taskUtil
-	 * @param {object} parameters.project Project configuration
-	 * @param {object} parameters.log <code>@ui5/logger</code> logger instance
-	 */
-	addStandardTasks({resourceCollections, project, log, taskUtil}) {
-		throw new Error("Function 'addStandardTasks' is not implemented");
-	}
-
-	/**
-	 * Adds custom tasks to execute
-	 *
-	 * @private
-	 * @param {object} parameters
-	 * @param {BuilderResourceCollections} parameters.resourceCollections Resource collections
-	 * @param {object} parameters.taskUtil
-	 * @param {object} parameters.project Project configuration
-	 */
-	addCustomTasks({resourceCollections, project, taskUtil}) {
-		const projectCustomTasks = project.builder && project.builder.customTasks;
-		if (!projectCustomTasks || projectCustomTasks.length === 0) {
-			return; // No custom tasks defined
-		}
-		const taskRepository = require("../tasks/taskRepository");
-		for (let i = 0; i < projectCustomTasks.length; i++) {
-			const taskDef = projectCustomTasks[i];
-			if (!taskDef.name) {
-				throw new Error(`Missing name for custom task definition of project ${project.metadata.name} ` +
-					`at index ${i}`);
-			}
-			if (taskDef.beforeTask && taskDef.afterTask) {
-				throw new Error(`Custom task definition ${taskDef.name} of project ${project.metadata.name} ` +
-					`defines both "beforeTask" and "afterTask" parameters. Only one must be defined.`);
-			}
-			if (this.taskExecutionOrder.length && !taskDef.beforeTask && !taskDef.afterTask) {
-				// Iff there are tasks configured, beforeTask or afterTask must be given
-				throw new Error(`Custom task definition ${taskDef.name} of project ${project.metadata.name} ` +
-					`defines neither a "beforeTask" nor an "afterTask" parameter. One must be defined.`);
-			}
-
-			let newTaskName = taskDef.name;
-			if (this.tasks[newTaskName]) {
-				// Task is already known
-				// => add a suffix to allow for multiple configurations of the same task
-				let suffixCounter = 0;
-				while (this.tasks[newTaskName]) {
-					suffixCounter++; // Start at 1
-					newTaskName = `${taskDef.name}--${suffixCounter}`;
-				}
-			}
-			// Create custom task if not already done (task might be referenced multiple times, first one wins)
-			const {specVersion, task} = taskRepository.getTask(taskDef.name);
-			const execTask = function() {
-				/* Custom Task Interface
-					Parameters:
-						{Object} parameters Parameters
-						{module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
-						{module:@ui5/fs.AbstractReader} parameters.dependencies
-							Reader or Collection to read dependency files
-						{Object} parameters.taskUtil Specification Version dependent interface to a
-							[TaskUtil]{@link module:@ui5/builder.tasks.TaskUtil} instance
-						{Object} parameters.options Options
-						{string} parameters.options.projectName Project name
-						{string} [parameters.options.projectNamespace] Project namespace if available
-						{string} [parameters.options.configuration] Task configuration if given in ui5.yaml
-					Returns:
-						{Promise<undefined>} Promise resolving with undefined once data has been written
-				*/
-				const params = {
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					options: {
-						projectName: project.metadata.name,
-						projectNamespace: project.metadata.namespace,
-						configuration: taskDef.configuration
-					}
-				};
-
-				const taskUtilInterface = taskUtil.getInterface(specVersion);
-				// Interface is undefined if specVersion does not support taskUtil
-				if (taskUtilInterface) {
-					params.taskUtil = taskUtilInterface;
-				}
-				return task(params);
-			};
-
-			this.tasks[newTaskName] = execTask;
-
-			if (this.taskExecutionOrder.length) {
-				// There is at least one task configured. Use before- and afterTask to add the custom task
-				const refTaskName = taskDef.beforeTask || taskDef.afterTask;
-				let refTaskIdx = this.taskExecutionOrder.indexOf(refTaskName);
-				if (refTaskIdx === -1) {
-					throw new Error(`Could not find task ${refTaskName}, referenced by custom task ${newTaskName}, ` +
-						`to be scheduled for project ${project.metadata.name}`);
-				}
-				if (taskDef.afterTask) {
-					// Insert after index of referenced task
-					refTaskIdx++;
-				}
-				this.taskExecutionOrder.splice(refTaskIdx, 0, newTaskName);
-			} else {
-				// There is no task configured so far. Just add the custom task
-				this.taskExecutionOrder.push(newTaskName);
-			}
-		}
-	}
-
-	/**
-	 * Adds a executable task to the builder
-	 *
-	 * The order this function is being called defines the build order. FIFO.
-	 *
-	 * @param {string} taskName Name of the task which should be in the list availableTasks.
-	 * @param {Function} taskFunction
-	 */
-	addTask(taskName, taskFunction) {
-		if (this.tasks[taskName]) {
-			throw new Error(`Failed to add duplicate task ${taskName} for project ${this.project.metadata.name}`);
-		}
-		if (this.taskExecutionOrder.includes(taskName)) {
-			throw new Error(`Builder: Failed to add task ${taskName} for project ${this.project.metadata.name}. ` +
-				`It has already been scheduled for execution.`);
-		}
-		this.tasks[taskName] = taskFunction;
-		this.taskExecutionOrder.push(taskName);
-	}
-
-	/**
-	 * Check whether a task is defined
-	 *
-	 * @private
-	 * @param {string} taskName
-	 * @returns {boolean}
-	 */
-	hasTask(taskName) {
-		// TODO 3.0: Check whether this method is still required.
-		// Only usage within #build seems to be unnecessary as all tasks are also added to the taskExecutionOrder
-		return Object.prototype.hasOwnProperty.call(this.tasks, taskName);
-	}
-
-	/**
-	 * Takes a list of tasks which should be executed from the available task list of the current builder
-	 *
-	 * @param {Array} tasksToRun List of tasks which should be executed
-	 * @returns {Promise} Returns promise chain with tasks
-	 */
-	build(tasksToRun) {
-		const allTasks = this.taskExecutionOrder.filter((taskName) => {
-			// There might be a numeric suffix in case a custom task is configured multiple times.
-			// The suffix needs to be removed in order to check against the list of tasks to run.
-			//
-			// Note: The 'tasksToRun' parameter only allows to specify the custom task name
-			// (without suffix), so it executes either all or nothing.
-			// It's currently not possible to just execute some occurrences of a custom task.
-			// This would require a more robust contract to identify task executions
-			// (e.g. via an 'id' that can be assigned to a specific execution in the configuration).
-			const taskWithoutSuffixCounter = taskName.replace(/--\d+$/, "");
-			return this.hasTask(taskName) && tasksToRun.includes(taskWithoutSuffixCounter);
-		});
-
-		this.taskLog.addWork(allTasks.length);
-
-		return allTasks.reduce((taskChain, taskName) => {
-			const taskFunction = this.tasks[taskName];
-
-			if (typeof taskFunction === "function") {
-				taskChain = taskChain.then(this.wrapTask(taskName, taskFunction));
-			}
-
-			return taskChain;
-		}, Promise.resolve());
-	}
-
-	/**
-	 * Adds progress related functionality to task function.
-	 *
-	 * @private
-	 * @param {string} taskName Name of the task
-	 * @param {Function} taskFunction Function which executed the task
-	 * @returns {Function} Wrapped task function
-	 */
-	wrapTask(taskName, taskFunction) {
-		return () => {
-			this.taskLog.startWork(`Running task ${taskName}...`);
-			return taskFunction().then(() => this.taskLog.completeWork(1));
-		};
-	}
-
-	/**
-	 * Appends the list of 'excludes' to the list of 'patterns'. To harmonize both lists, the 'excludes'
-	 * are negated and the 'patternPrefix' is added to make them absolute.
-	 *
-	 * @private
-	 * @param {string[]} patterns
-	 *   List of absolute default patterns.
-	 * @param {string[]} excludes
-	 *   List of relative patterns to be excluded. Excludes with a leading "!" are meant to be re-included.
-	 * @param {string} patternPrefix
-	 *   Prefix to be added to the excludes to make them absolute. The prefix must have a leading and a
-	 *   trailing "/".
-	 */
-	enhancePatternWithExcludes(patterns, excludes, patternPrefix) {
-		excludes.forEach((exclude) => {
-			if (exclude.startsWith("!")) {
-				patterns.push(`${patternPrefix}${exclude.slice(1)}`);
-			} else {
-				patterns.push(`!${patternPrefix}${exclude}`);
-			}
-		});
-	}
-}
-
-module.exports = AbstractBuilder;

package/lib/types/AbstractFormatter.js

@@ -1,66 +0,0 @@
-const fs = require("graceful-fs");
-
-/**
- * Base class for the formatter implementation of a project type.
- *
- * @abstract
- */
-class AbstractFormatter {
-	/**
-	 * Constructor
-	 *
-	 * @param {object} parameters
-	 * @param {object} parameters.project Project
-	 */
-	constructor({project}) {
-		if (new.target === AbstractFormatter) {
-			throw new TypeError("Class 'AbstractFormatter' is abstract");
-		}
-		this._project = project;
-	}
-
-	/**
-	 * Formats and validates the project
-	 *
-	 * @returns {Promise}
-	 */
-	format() {
-		throw new Error("AbstractFormatter: Function format Not implemented");
-	}
-
-	/**
-	 * Validates the project
-	 *
-	 * @returns {Promise} resolves if successfully validated
-	 * @throws {Error} if validation fails
-	 */
-	validate() {
-		throw new Error("AbstractFormatter: Function validate Not implemented");
-	}
-
-	/**
-	 * Checks whether or not the given input is a directory on the file system.
-	 *
-	 * @param {string} dirPath directory
-	 * @returns {Promise<boolean>} whether or not the given directory exists.
-	 * <code>true</code> directory exists
-	 * <code>false</code> directory does not exist
-	 */
-	dirExists(dirPath) {
-		return new Promise((resolve, reject) => {
-			fs.stat(dirPath, (err, stats) => {
-				if (err) {
-					if (err.code === "ENOENT") { // "File or directory does not exist"
-						resolve(false);
-					} else {
-						reject(err);
-					}
-				} else {
-					resolve(stats.isDirectory());
-				}
-			});
-		});
-	}
-}
-
-module.exports = AbstractFormatter;

package/lib/types/AbstractUi5Formatter.js

@@ -1,95 +0,0 @@
-const log = require("@ui5/logger").getLogger("types:AbstractUi5Formatter");
-const path = require("path");
-const fs = require("graceful-fs");
-const AbstractFormatter = require("./AbstractFormatter");
-const {promisify} = require("util");
-const readFile = promisify(fs.readFile);
-
-/**
- * Base class for formatters that require access to some UI5 specific resources
- * like pom.xml
- *
- * @abstract
- */
-class AbstractUi5Formatter extends AbstractFormatter {
-	/**
-	 * Constructor
-	 *
-	 * @param {object} parameters
-	 * @param {object} parameters.project Project
-	 */
-	constructor(parameters) {
-		super(parameters);
-		if (new.target === AbstractUi5Formatter) {
-			throw new TypeError("Class 'AbstractUi5Formatter' is abstract");
-		}
-	}
-
-	/**
-	 * Checks whether a given string contains a maven placeholder.
-	 * E.g. <code>${appId}</code>.
-	 *
-	 * @param {string} value String to check
-	 * @returns {boolean} True if given string contains a maven placeholder
-	 */
-	hasMavenPlaceholder(value) {
-		return !!value.match(/^\$\{(.*)\}$/);
-	}
-
-	/**
-	 * Resolves a maven placeholder in a given string using the projects pom.xml
-	 *
-	 * @param {string} value String containing a maven placeholder
-	 * @returns {Promise<string>} Resolved string
-	 */
-	async resolveMavenPlaceholder(value) {
-		const parts = value && value.match(/^\$\{(.*)\}$/);
-		if (parts) {
-			log.verbose(`"${value} contains a maven placeholder "${parts[1]}". Resolving from projects pom.xml...`);
-			const pom = await this.getPom();
-			let mvnValue;
-			if (pom.project && pom.project.properties && pom.project.properties[parts[1]]) {
-				mvnValue = pom.project.properties[parts[1]];
-			} else {
-				let obj = pom;
-				parts[1].split(".").forEach((part) => {
-					obj = obj && obj[part];
-				});
-				mvnValue = obj;
-			}
-			if (!mvnValue) {
-				throw new Error(`"${value}" couldn't be resolved from maven property ` +
-					`"${parts[1]}" of pom.xml of project ${this._project.metadata.name}`);
-			}
-			return mvnValue;
-		} else {
-			throw new Error(`"${value}" is not a maven placeholder`);
-		}
-	}
-
-	/**
-	 * Reads the projects pom.xml file
-	 *
-	 * @returns {Promise<object>} Resolves with a JSON representation of the content
-	 */
-	async getPom() {
-		if (this._pPom) {
-			return this._pPom;
-		}
-		const fsPath = path.join(this._project.path, "pom.xml");
-		return this._pPom = readFile(fsPath).then(async (content) => {
-			const xml2js = require("xml2js");
-			const parser = new xml2js.Parser({
-				explicitArray: false,
-				ignoreAttrs: true
-			});
-			const readXML = promisify(parser.parseString);
-			return readXML(content);
-		}).catch((err) => {
-			throw new Error(
-				`Failed to read pom.xml for project ${this._project.metadata.name}: ${err.message}`);
-		});
-	}
-}
-
-module.exports = AbstractUi5Formatter;