@ui5/builder 3.0.0-alpha.1 → 3.0.0-alpha.11

package/lib/builder/ProjectBuildContext.js

@@ -1,57 +0,0 @@
-const ResourceTagCollection = require("@ui5/fs").ResourceTagCollection;
-
-// Note: When adding standard tags, always update the public documentation in TaskUtil
-// (Type "module:@ui5/builder.tasks.TaskUtil~StandardBuildTags")
-const STANDARD_TAGS = {
-	OmitFromBuildResult: "ui5:OmitFromBuildResult",
-	IsBundle: "ui5:IsBundle",
-};
-
-/**
- * Build context of a single project. Always part of an overall
- * [Build Context]{@link module:@ui5/builder.builder.BuildContext}
- *
- * @private
- * @memberof module:@ui5/builder.builder
- */
-class ProjectBuildContext {
-	constructor({buildContext, globalTags, project, resources}) {
-		if (!buildContext || !globalTags || !project || !resources) {
-			throw new Error(`One or more mandatory parameters are missing`);
-		}
-		this._buildContext = buildContext;
-		this._project = project;
-		// this.resources = resources;
-		this.queues = {
-			cleanup: []
-		};
-
-		this.STANDARD_TAGS = Object.assign({}, STANDARD_TAGS, globalTags);
-		Object.freeze(this.STANDARD_TAGS);
-
-		this._resourceTagCollection = new ResourceTagCollection({
-			allowedTags: Object.values(this.STANDARD_TAGS),
-			superCollection: this._buildContext.getResourceTagCollection()
-		});
-	}
-
-	isRootProject() {
-		return this._project === this._buildContext.getRootProject();
-	}
-
-	registerCleanupTask(callback) {
-		this.queues.cleanup.push(callback);
-	}
-
-	async executeCleanupTasks() {
-		await Promise.all(this.queues.cleanup.map((callback) => {
-			return callback();
-		}));
-	}
-
-	getResourceTagCollection() {
-		return this._resourceTagCollection;
-	}
-}
-
-module.exports = ProjectBuildContext;

package/lib/builder/builder.js

@@ -1,419 +0,0 @@
-const {promisify} = require("util");
-const rimraf = promisify(require("rimraf"));
-const log = require("@ui5/logger").getGroupLogger("builder:builder");
-const resourceFactory = require("@ui5/fs").resourceFactory;
-const MemAdapter = require("@ui5/fs").adapters.Memory;
-const typeRepository = require("../types/typeRepository");
-const taskRepository = require("../tasks/taskRepository");
-const BuildContext = require("./BuildContext");
-
-
-// Set of tasks for development
-const devTasks = [
-	"replaceCopyright",
-	"replaceVersion",
-	"replaceBuildtime",
-	"buildThemes"
-];
-
-/**
- * Calculates the elapsed build time and returns a prettified output
- *
- * @private
- * @param {Array} startTime Array provided by <code>process.hrtime()</code>
- * @returns {string} Difference between now and the provided time array as formatted string
- */
-function getElapsedTime(startTime) {
-	const prettyHrtime = require("pretty-hrtime");
-	const timeDiff = process.hrtime(startTime);
-	return prettyHrtime(timeDiff);
-}
-
-/**
- * Creates the list of tasks to be executed by the build process
- *
- * Sets specific tasks to be disabled by default, these tasks need to be included explicitly.
- * Based on the selected build mode (dev|selfContained|preload), different tasks are enabled.
- * Tasks can be enabled or disabled. The wildcard <code>*</code> is also supported and affects all tasks.
- *
- * @private
- * @param {object} parameters
- * @param {boolean} parameters.dev Sets development mode, which only runs essential tasks
- * @param {boolean} parameters.selfContained
- *			True if a the build should be self-contained or false for prelead build bundles
- * @param {boolean} parameters.jsdoc True if a JSDoc build should be executed
- * @param {Array} parameters.includedTasks Task list to be included from build
- * @param {Array} parameters.excludedTasks Task list to be excluded from build
- * @returns {Array} Return a task list for the builder
- */
-function composeTaskList({dev, selfContained, jsdoc, includedTasks, excludedTasks}) {
-	const definedTasks = taskRepository.getAllTaskNames();
-	let selectedTasks = definedTasks.reduce((list, key) => {
-		list[key] = true;
-		return list;
-	}, {});
-
-	// Exclude non default tasks
-	selectedTasks.generateManifestBundle = false;
-	selectedTasks.generateStandaloneAppBundle = false;
-	selectedTasks.transformBootstrapHtml = false;
-	selectedTasks.generateJsdoc = false;
-	selectedTasks.executeJsdocSdkTransformation = false;
-	selectedTasks.generateCachebusterInfo = false;
-	selectedTasks.generateApiIndex = false;
-	selectedTasks.generateThemeDesignerResources = false;
-
-	// Disable generateResourcesJson due to performance.
-	// When executed it analyzes each module's AST and therefore
-	// takes up much time (~10% more)
-	selectedTasks.generateResourcesJson = false;
-
-	if (selfContained) {
-		// No preloads, bundle only
-		selectedTasks.generateComponentPreload = false;
-		selectedTasks.generateStandaloneAppBundle = true;
-		selectedTasks.transformBootstrapHtml = true;
-		selectedTasks.generateLibraryPreload = false;
-	}
-
-	// TODO 3.0: exclude generateVersionInfo if not --all is used
-
-	if (jsdoc) {
-		// Include JSDoc tasks
-		selectedTasks.generateJsdoc = true;
-		selectedTasks.executeJsdocSdkTransformation = true;
-		selectedTasks.generateApiIndex = true;
-
-		// Include theme build as required for SDK
-		selectedTasks.buildThemes = true;
-
-		// Exclude all tasks not relevant to JSDoc generation
-		selectedTasks.replaceCopyright = false;
-		selectedTasks.replaceVersion = false;
-		selectedTasks.replaceBuildtime = false;
-		selectedTasks.generateComponentPreload = false;
-		selectedTasks.generateLibraryPreload = false;
-		selectedTasks.generateLibraryManifest = false;
-		selectedTasks.minify = false;
-		selectedTasks.generateFlexChangesBundle = false;
-		selectedTasks.generateManifestBundle = false;
-	}
-
-	// Only run essential tasks in development mode, it is not desired to run time consuming tasks during development.
-	if (dev) {
-		// Overwrite all other tasks with noop promise
-		Object.keys(selectedTasks).forEach((key) => {
-			if (devTasks.indexOf(key) === -1) {
-				selectedTasks[key] = false;
-			}
-		});
-	}
-
-	// Exclude tasks
-	for (let i = 0; i < excludedTasks.length; i++) {
-		const taskName = excludedTasks[i];
-		if (taskName === "*") {
-			Object.keys(selectedTasks).forEach((sKey) => {
-				selectedTasks[sKey] = false;
-			});
-			break;
-		}
-		if (selectedTasks[taskName] === true) {
-			selectedTasks[taskName] = false;
-		} else if (typeof selectedTasks[taskName] === "undefined") {
-			log.warn(`Unable to exclude task '${taskName}': Task is unknown`);
-		}
-	}
-
-	// Include tasks
-	for (let i = 0; i < includedTasks.length; i++) {
-		const taskName = includedTasks[i];
-		if (taskName === "*") {
-			Object.keys(selectedTasks).forEach((sKey) => {
-				selectedTasks[sKey] = true;
-			});
-			break;
-		}
-		if (selectedTasks[taskName] === false) {
-			selectedTasks[taskName] = true;
-		} else if (typeof selectedTasks[taskName] === "undefined") {
-			log.warn(`Unable to include task '${taskName}': Task is unknown`);
-		}
-	}
-
-	// Filter only for tasks that will be executed
-	selectedTasks = Object.keys(selectedTasks).filter((task) => selectedTasks[task]);
-
-	return selectedTasks;
-}
-
-async function executeCleanupTasks(buildContext) {
-	log.info("Executing cleanup tasks...");
-	await buildContext.executeCleanupTasks();
-}
-
-function registerCleanupSigHooks(buildContext) {
-	function createListener(exitCode) {
-		return function() {
-			// Asynchronously cleanup resources, then exit
-			executeCleanupTasks(buildContext).then(() => {
-				process.exit(exitCode);
-			});
-		};
-	}
-
-	const processSignals = {
-		"SIGHUP": createListener(128 + 1),
-		"SIGINT": createListener(128 + 2),
-		"SIGTERM": createListener(128 + 15),
-		"SIGBREAK": createListener(128 + 21)
-	};
-
-	for (const signal of Object.keys(processSignals)) {
-		process.on(signal, processSignals[signal]);
-	}
-
-	// == TO BE DISCUSSED: Also cleanup for unhandled rejections and exceptions?
-	// Add additional events like signals since they are registered on the process
-	//	event emitter in a similar fashion
-	// processSignals["unhandledRejection"] = createListener(1);
-	// process.once("unhandledRejection", processSignals["unhandledRejection"]);
-	// processSignals["uncaughtException"] = function(err, origin) {
-	// 	const fs = require("fs");
-	// 	fs.writeSync(
-	// 		process.stderr.fd,
-	// 		`Caught exception: ${err}\n` +
-	// 		`Exception origin: ${origin}`
-	// 	);
-	// 	createListener(1)();
-	// };
-	// process.once("uncaughtException", processSignals["uncaughtException"]);
-
-	return processSignals;
-}
-
-function deregisterCleanupSigHooks(signals) {
-	for (const signal of Object.keys(signals)) {
-		process.removeListener(signal, signals[signal]);
-	}
-}
-
-/**
- * Builder
- *
- * @public
- * @namespace
- * @alias module:@ui5/builder.builder
- */
-module.exports = {
-	/**
-	 * Configures the project build and starts it.
-	 *
-	 * @public
-	 * @param {object} parameters Parameters
-	 * @param {object} parameters.tree Project tree as generated by the
-	 * 									[@ui5/project.normalizer]{@link module:@ui5/project.normalizer}
-	 * @param {string} parameters.destPath Target path
-	 * @param {boolean} [parameters.cleanDest=false] Decides whether project should clean the target path before build
-	 * @param {boolean} [parameters.buildDependencies=false] Decides whether project dependencies are built as well
-	 * @param {Array.<string|RegExp>} [parameters.includedDependencies=[]]
-	 *			List of build dependencies to be included if buildDependencies is true
-	 * @param {Array.<string|RegExp>} [parameters.excludedDependencies=[]]
-	 *			List of build dependencies to be excluded if buildDependencies is true.
-	 *			If the wildcard '*' is provided, only the included dependencies will be built.
-	 * @param {boolean} [parameters.dev=false]
-	 *			Decides whether a development build should be activated (skips non-essential and time-intensive tasks)
-	 * @param {boolean} [parameters.selfContained=false] Flag to activate self contained build
-	 * @param {boolean} [parameters.jsdoc=false] Flag to activate JSDoc build
-	 * @param {Array.<string>} [parameters.includedTasks=[]] List of tasks to be included
-	 * @param {Array.<string>} [parameters.excludedTasks=[]] List of tasks to be excluded.
-	 * 							If the wildcard '*' is provided, only the included tasks will be executed.
-	 * @param {Array.<string>} [parameters.devExcludeProject=[]] List of projects to be excluded from development build
-	 * @returns {Promise} Promise resolving to <code>undefined</code> once build has finished
-	 */
-	async build({
-		tree, destPath, cleanDest = false,
-		buildDependencies = false, includedDependencies = [], excludedDependencies = [],
-		dev = false, selfContained = false, jsdoc = false,
-		includedTasks = [], excludedTasks = [], devExcludeProject = []
-	}) {
-		const startTime = process.hrtime();
-		log.info(`Building project ${tree.metadata.name}` + (buildDependencies ? "" : " not") +
-			" including dependencies..." + (dev ? " [dev mode]" : ""));
-		log.verbose(`Building to ${destPath}...`);
-
-		const selectedTasks = composeTaskList({dev, selfContained, jsdoc, includedTasks, excludedTasks});
-
-		const fsTarget = resourceFactory.createAdapter({
-			fsBasePath: destPath,
-			virBasePath: "/"
-		});
-
-		const buildContext = new BuildContext({rootProject: tree});
-		const cleanupSigHooks = registerCleanupSigHooks(buildContext);
-
-		const projects = {}; // Unique project index to prevent building the same project multiple times
-		const projectWriters = {}; // Collection of memory adapters of already built libraries
-		function projectFilter(project) {
-			function projectMatchesAny(deps) {
-				return deps.some((dep) => dep instanceof RegExp ?
-					dep.test(project.metadata.name) : dep === project.metadata.name);
-			}
-
-			// if everything is included, this overrules exclude lists
-			if (includedDependencies.includes("*")) return true;
-			let test = !excludedDependencies.includes("*"); // exclude everything?
-
-			if (test && projectMatchesAny(excludedDependencies)) {
-				test = false;
-			}
-			if (!test && projectMatchesAny(includedDependencies)) {
-				test = true;
-			}
-
-			return test;
-		}
-
-		const projectCountMarker = {};
-		function projectCount(project, count = 0) {
-			if (buildDependencies) {
-				count = project.dependencies.filter(projectFilter).reduce((depCount, depProject) => {
-					return projectCount(depProject, depCount);
-				}, count);
-			}
-			if (!projectCountMarker[project.metadata.name]) {
-				count++;
-				projectCountMarker[project.metadata.name] = true;
-			}
-			return count;
-		}
-		const buildLogger = log.createTaskLogger("🛠 ", projectCount(tree));
-
-		function buildProject(project) {
-			const projectBasePath = `/resources/${project.metadata.namespace}`;
-			let depPromise;
-			let projectTasks = selectedTasks;
-
-			// Build dependencies in sequence as it is far easier to detect issues and reduces
-			// side effects or other issues such as too many open files
-			if (buildDependencies) {
-				depPromise = project.dependencies.filter(projectFilter).reduce(function(p, depProject) {
-					return p.then(() => buildProject(depProject));
-				}, Promise.resolve());
-			} else {
-				depPromise = Promise.resolve();
-			}
-
-			// Build the project after all dependencies have been built
-			return depPromise.then(() => {
-				if (projects[project.metadata.name]) {
-					return Promise.resolve();
-				} else {
-					projects[project.metadata.name] = true;
-				}
-				buildLogger.startWork(`Building project ${project.metadata.name}`);
-
-				const projectType = typeRepository.getType(project.type);
-				const resourceCollections = resourceFactory.createCollectionsForTree(project, {
-					virtualReaders: projectWriters,
-					getVirtualBasePathPrefix: function({project, virBasePath}) {
-						if (project.type === "application" && project.metadata.namespace) {
-							return projectBasePath;
-						}
-					},
-					getProjectExcludes: function(project) {
-						if (project.builder && project.builder.resources) {
-							return project.builder.resources.excludes;
-						}
-					}
-				});
-
-				const writer = new MemAdapter({
-					virBasePath: "/"
-				});
-				// Store project writer as virtual reader for parent projects
-				//	so they can access the build results of this project
-				projectWriters[project.metadata.name] = writer;
-
-				// TODO: Add getter for writer of DuplexColection
-				const workspace = resourceFactory.createWorkspace({
-					virBasePath: "/",
-					writer,
-					reader: resourceCollections.source,
-					name: project.metadata.name
-				});
-
-				const projectContext = buildContext.createProjectContext({
-					project, // TODO 2.0: Add project facade object/instance here
-					resources: {
-						workspace,
-						dependencies: resourceCollections.dependencies
-					}
-				});
-
-				const TaskUtil = require("../tasks/TaskUtil");
-				const taskUtil = new TaskUtil({
-					projectBuildContext: projectContext
-				});
-
-				if (dev && devExcludeProject.indexOf(project.metadata.name) !== -1) {
-					projectTasks = composeTaskList({dev: false, selfContained, includedTasks, excludedTasks});
-				}
-
-				return projectType.build({
-					resourceCollections: {
-						workspace,
-						dependencies: resourceCollections.dependencies
-					},
-					tasks: projectTasks,
-					project,
-					parentLogger: log,
-					taskUtil
-				}).then(() => {
-					log.verbose("Finished building project %s. Writing out files...", project.metadata.name);
-					buildLogger.completeWork(1);
-
-					return workspace.byGlob("/**/*").then((resources) => {
-						const tagCollection = projectContext.getResourceTagCollection();
-						return Promise.all(resources.map((resource) => {
-							if (tagCollection.getTag(resource, projectContext.STANDARD_TAGS.OmitFromBuildResult)) {
-								log.verbose(`Skipping write of resource tagged as "OmitFromBuildResult": ` +
-									resource.getPath());
-								return; // Skip target write for this resource
-							}
-							if (projectContext.isRootProject() && project.type === "application" &&
-									project.metadata.namespace) {
-								// Root-application projects only: Remove namespace prefix if given
-								const resourcePath = resource.getPath();
-								if (resourcePath.startsWith(projectBasePath)) {
-									resource.setPath(resourcePath.replace(projectBasePath, ""));
-								}
-							}
-							return fsTarget.write(resource);
-						}));
-					});
-				});
-			});
-		}
-
-		try {
-			if (cleanDest) {
-				await rimraf(destPath);
-			}
-			await buildProject(tree);
-			log.info(`Build succeeded in ${getElapsedTime(startTime)}`);
-		} catch (err) {
-			log.error(`Build failed in ${getElapsedTime(startTime)}`);
-			throw err;
-		} finally {
-			deregisterCleanupSigHooks(cleanupSigHooks);
-			await executeCleanupTasks(buildContext);
-		}
-	}
-};
-
-// Export local function for testing only
-/* istanbul ignore else */
-if (process.env.NODE_ENV === "test") {
-	module.exports._composeTaskList = composeTaskList;
-}

package/lib/tasks/TaskUtil.js

@@ -1,160 +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();
-	}
-
-	/**
-	 * 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;