@ui5/builder 3.0.0-alpha.5 → 3.0.0-alpha.8

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;

package/lib/types/application/ApplicationBuilder.js

@@ -1,211 +0,0 @@
-const AbstractBuilder = require("../AbstractBuilder");
-const {getTask} = require("../../tasks/taskRepository");
-
-class ApplicationBuilder extends AbstractBuilder {
-	addStandardTasks({resourceCollections, project, log, taskUtil}) {
-		if (!project.metadata.namespace) {
-			// TODO 3.0: Throw here
-			log.info("Skipping some tasks due to missing application namespace information. If your project contains " +
-					"a Component.js, you might be missing a manifest.json file. " +
-					"Also see: https://sap.github.io/ui5-tooling/pages/Builder/#application");
-		}
-
-		this.addTask("escapeNonAsciiCharacters", async () => {
-			const propertiesFileSourceEncoding = project.resources &&
-			project.resources.configuration &&
-			project.resources.configuration.propertiesFileSourceEncoding;
-			return getTask("escapeNonAsciiCharacters").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					encoding: propertiesFileSourceEncoding,
-					pattern: "/**/*.properties"
-				}
-			});
-		});
-
-		this.addTask("replaceCopyright", async () => {
-			return getTask("replaceCopyright").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					copyright: project.metadata.copyright,
-					pattern: "/**/*.{js,json}"
-				}
-			});
-		});
-
-		this.addTask("replaceVersion", async () => {
-			return getTask("replaceVersion").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					version: project.version,
-					pattern: "/**/*.{js,json}"
-				}
-			});
-		});
-
-		// Support rules should not be minified to have readable code in the Support Assistant
-		const minificationPattern = ["/**/*.js", "!**/*.support.js"];
-		if (["2.6"].includes(project.specVersion)) {
-			const minificationExcludes = project.builder && project.builder.minification &&
-						project.builder.minification.excludes;
-			if (minificationExcludes) {
-				// TODO 3.0: namespaces should become mandatory, see existing check above
-				const patternPrefix = project.metadata.namespace ? "/resources/" : "/";
-				this.enhancePatternWithExcludes(minificationPattern, minificationExcludes, patternPrefix);
-			}
-		}
-		this.addTask("minify", async () => {
-			return getTask("minify").task({
-				workspace: resourceCollections.workspace,
-				taskUtil,
-				options: {
-					pattern: minificationPattern
-				}
-			});
-		});
-
-		this.addTask("generateFlexChangesBundle", async () => {
-			const generateFlexChangesBundle = getTask("generateFlexChangesBundle").task;
-			return generateFlexChangesBundle({
-				workspace: resourceCollections.workspace,
-				taskUtil,
-				options: {
-					namespace: project.metadata.namespace
-				}
-			});
-		});
-
-		if (project.metadata.namespace) {
-			this.addTask("generateManifestBundle", async () => {
-				const generateManifestBundle = getTask("generateManifestBundle").task;
-				return generateManifestBundle({
-					workspace: resourceCollections.workspace,
-					options: {
-						projectName: project.metadata.name,
-						namespace: project.metadata.namespace
-					}
-				});
-			});
-		}
-
-		const componentPreload = project.builder && project.builder.componentPreload;
-		if (componentPreload && (componentPreload.namespaces || componentPreload.paths)) {
-			this.addTask("generateComponentPreload", async () => {
-				return getTask("generateComponentPreload").task({
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					taskUtil,
-					options: {
-						projectName: project.metadata.name,
-						paths: componentPreload.paths,
-						namespaces: componentPreload.namespaces,
-						excludes: componentPreload.excludes
-					}
-				});
-			});
-		} else if (project.metadata.namespace) {
-			// Default component preload for application namespace
-			this.addTask("generateComponentPreload", async () => {
-				return getTask("generateComponentPreload").task({
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					taskUtil,
-					options: {
-						projectName: project.metadata.name,
-						namespaces: [project.metadata.namespace],
-						excludes: componentPreload && componentPreload.excludes
-					}
-				});
-			});
-		}
-
-		this.addTask("generateStandaloneAppBundle", async () => {
-			return getTask("generateStandaloneAppBundle").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				taskUtil,
-				options: {
-					projectName: project.metadata.name,
-					namespace: project.metadata.namespace
-				}
-			});
-		});
-
-		this.addTask("transformBootstrapHtml", async () => {
-			return getTask("transformBootstrapHtml").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					projectName: project.metadata.name,
-					namespace: project.metadata.namespace
-				}
-			});
-		});
-
-		const bundles = project.builder && project.builder.bundles;
-		if (bundles) {
-			this.addTask("generateBundle", async () => {
-				return Promise.all(bundles.map((bundle) => {
-					return getTask("generateBundle").task({
-						workspace: resourceCollections.workspace,
-						dependencies: resourceCollections.dependencies,
-						taskUtil,
-						options: {
-							projectName: project.metadata.name,
-							bundleDefinition: bundle.bundleDefinition,
-							bundleOptions: bundle.bundleOptions
-						}
-					});
-				}));
-			});
-		}
-
-		this.addTask("generateVersionInfo", async () => {
-			return getTask("generateVersionInfo").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				options: {
-					rootProject: project,
-					pattern: "/resources/**/.library"
-				}
-			});
-		});
-
-		if (project.metadata.namespace) {
-			this.addTask("generateCachebusterInfo", async () => {
-				return getTask("generateCachebusterInfo").task({
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					options: {
-						namespace: project.metadata.namespace,
-						signatureType: project.builder &&
-							project.builder.cachebuster &&
-							project.builder.cachebuster.signatureType,
-					}
-				});
-			});
-		}
-
-		this.addTask("generateApiIndex", async () => {
-			return getTask("generateApiIndex").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				options: {
-					projectName: project.metadata.name
-				}
-			});
-		});
-
-		this.addTask("generateResourcesJson", () => {
-			return getTask("generateResourcesJson").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				taskUtil,
-				options: {
-					projectName: project.metadata.name
-				}
-			});
-		});
-	}
-}
-
-module.exports = ApplicationBuilder;

package/lib/types/application/ApplicationFormatter.js

@@ -1,227 +0,0 @@
-const log = require("@ui5/logger").getLogger("types:application:ApplicationFormatter");
-const path = require("path");
-const fs = require("graceful-fs");
-const {promisify} = require("util");
-const readFile = promisify(fs.readFile);
-const AbstractUi5Formatter = require("../AbstractUi5Formatter");
-
-class ApplicationFormatter extends AbstractUi5Formatter {
-	/**
-	 * Constructor
-	 *
-	 * @param {object} parameters
-	 * @param {object} parameters.project Project
-	 */
-	constructor(parameters) {
-		super(parameters);
-		this._pManifests = {};
-	}
-	/**
-	 * Formats and validates the project
-	 *
-	 * @returns {Promise}
-	 */
-	async format() {
-		const project = this._project;
-		await this.validate();
-		log.verbose("Formatting application project %s...", project.metadata.name);
-		project.resources.pathMappings = {
-			"/": project.resources.configuration.paths.webapp
-		};
-
-		project.metadata.namespace = await this.getNamespace();
-	}
-
-	/**
-	 * Returns the base *source* path of the project. Runtime resources like manifest.json are expected
-	 * to be located inside this path.
-	 *
-	 * @param {boolean} [posix] whether to return a POSIX path
-	 * @returns {string} Base source path of the project
-	 */
-	getSourceBasePath(posix) {
-		let p = path;
-		let projectPath = this._project.path;
-		if (posix) {
-			projectPath = projectPath.replace(/\\/g, "/");
-			p = path.posix;
-		}
-		return p.join(projectPath, this._project.resources.pathMappings["/"]);
-	}
-
-	/**
-	 * Determine application namespace either based on a project`s
-	 * manifest.json or manifest.appdescr_variant (fallback if present)
-	 *
-	 * @returns {string} Namespace of the project
-	 * @throws {Error} if namespace can not be determined
-	 */
-	async getNamespace() {
-		try {
-			return await this.getNamespaceFromManifestJson();
-		} catch (manifestJsonError) {
-			if (manifestJsonError.code !== "ENOENT") {
-				throw manifestJsonError;
-			}
-			// No manifest.json present
-			// => attempt fallback to manifest.appdescr_variant (typical for App Variants)
-			try {
-				return await this.getNamespaceFromManifestAppDescVariant();
-			} catch (appDescVarError) {
-				if (appDescVarError.code === "ENOENT") {
-					// Fallback not possible: No manifest.appdescr_variant present
-					// => Throw error indicating missing manifest.json
-					// 	(do not mention manifest.appdescr_variant since it is only
-					// 	relevant for the rather "uncommon" App Variants)
-					throw new Error(
-						`Could not find required manifest.json for project ` +
-						`${this._project.metadata.name}: ${manifestJsonError.message}`);
-				}
-				throw appDescVarError;
-			}
-		}
-	}
-
-	/**
-	 * Determine application namespace by checking manifest.json.
-	 * Any maven placeholders are resolved from the projects pom.xml
-	 *
-	 * @returns {string} Namespace of the project
-	 * @throws {Error} if namespace can not be determined
-	 */
-	async getNamespaceFromManifestJson() {
-		const {content: manifest} = await this.getJson("manifest.json");
-		let appId;
-		// check for a proper sap.app/id in manifest.json to determine namespace
-		if (manifest["sap.app"] && manifest["sap.app"].id) {
-			appId = manifest["sap.app"].id;
-		} else {
-			throw new Error(
-				`No sap.app/id configuration found in manifest.json of project ${this._project.metadata.name}`);
-		}
-
-		if (this.hasMavenPlaceholder(appId)) {
-			try {
-				appId = await this.resolveMavenPlaceholder(appId);
-			} catch (err) {
-				throw new Error(
-					`Failed to resolve namespace of project ${this._project.metadata.name}: ${err.message}`);
-			}
-		}
-		const namespace = appId.replace(/\./g, "/");
-		log.verbose(
-			`Namespace of project ${this._project.metadata.name} is ${namespace} (from manifest.json)`);
-		return namespace;
-	}
-
-	/**
-	 * Determine application namespace by checking manifest.appdescr_variant.
-	 *
-	 * @returns {string} Namespace of the project
-	 * @throws {Error} if namespace can not be determined
-	 */
-	async getNamespaceFromManifestAppDescVariant() {
-		const {content: manifest} = await this.getJson("manifest.appdescr_variant");
-		let appId;
-		// check for the id property in manifest.appdescr_variant to determine namespace
-		if (manifest && manifest.id) {
-			appId = manifest.id;
-		} else {
-			throw new Error(
-				`No "id" property found in manifest.appdescr_variant of project ${this._project.metadata.name}`);
-		}
-
-		const namespace = appId.replace(/\./g, "/");
-		log.verbose(
-			`Namespace of project ${this._project.metadata.name} is ${namespace} (from manifest.appdescr_variant)`);
-		return namespace;
-	}
-
-	/**
-	 * Reads and parses a JSON file with the provided name from the projects source directory
-	 *
-	 * @param {string} fileName Name of the JSON file to read. Typically "manifest.json" or "manifest.appdescr_variant"
-	 * @returns {Promise<object>} resolves with an object containing the <code>content</code> (as JSON) and
-	 * 							<code>fsPath</code> (as string) of the requested file
-	 */
-	async getJson(fileName) {
-		if (this._pManifests[fileName]) {
-			return this._pManifests[fileName];
-		}
-		const fsPath = path.join(this.getSourceBasePath(), fileName);
-		return this._pManifests[fileName] = readFile(fsPath)
-			.then((content) => {
-				return {
-					content: JSON.parse(content),
-					fsPath
-				};
-			})
-			.catch((err) => {
-				if (err.code === "ENOENT") {
-					throw err;
-				}
-				throw new Error(
-					`Failed to read ${fileName} for project ` +
-					`${this._project.metadata.name}: ${err.message}`);
-			});
-	}
-
-	/**
-	 * Validates the project
-	 *
-	 * @returns {Promise} resolves if successfully validated
-	 * @throws {Error} if validation fails
-	 */
-	validate() {
-		const project = this._project;
-		return Promise.resolve().then(() => {
-			if (!project) {
-				throw new Error("Project is undefined");
-			} else if (!project.metadata || !project.metadata.name) {
-				throw new Error(`"metadata.name" configuration is missing for project ${project.id}`);
-			} else if (!project.type) {
-				throw new Error(`"type" configuration is missing for project ${project.id}`);
-			} else if (project.version === undefined) {
-				throw new Error(`"version" is missing for project ${project.id}`);
-			}
-
-			if (!project.resources) {
-				project.resources = {};
-			}
-			if (!project.resources.configuration) {
-				project.resources.configuration = {};
-			}
-			if (!project.resources.configuration.paths) {
-				project.resources.configuration.paths = {};
-			}
-			if (!project.resources.configuration.paths.webapp) {
-				project.resources.configuration.paths.webapp = "webapp";
-			}
-
-			if (!project.resources.configuration.propertiesFileSourceEncoding) {
-				if (["0.1", "1.0", "1.1"].includes(project.specVersion)) {
-					// default encoding to "ISO-8859-1" for old specVersions
-					project.resources.configuration.propertiesFileSourceEncoding = "ISO-8859-1";
-				} else {
-					// default encoding to "UTF-8" for all projects starting with specVersion 2.0
-					project.resources.configuration.propertiesFileSourceEncoding = "UTF-8";
-				}
-			}
-			if (!["ISO-8859-1", "UTF-8"].includes(project.resources.configuration.propertiesFileSourceEncoding)) {
-				throw new Error(`Invalid properties file encoding specified for project ${project.id}. ` +
-					`Encoding provided: ${project.resources.configuration.propertiesFileSourceEncoding}. ` +
-					`Must be either "ISO-8859-1" or "UTF-8".`);
-			}
-
-			const absolutePath = path.join(project.path, project.resources.configuration.paths.webapp);
-			return this.dirExists(absolutePath).then((bExists) => {
-				if (!bExists) {
-					throw new Error(`Could not find application directory of project ${project.id}: ` +
-						`${absolutePath}`);
-				}
-			});
-		});
-	}
-}
-
-module.exports = ApplicationFormatter;

package/lib/types/application/applicationType.js

@@ -1,15 +0,0 @@
-const ApplicationFormatter = require("./ApplicationFormatter");
-const ApplicationBuilder = require("./ApplicationBuilder");
-
-module.exports = {
-	format: function(project) {
-		return new ApplicationFormatter({project}).format();
-	},
-	build: function({resourceCollections, tasks, project, parentLogger, taskUtil}) {
-		return new ApplicationBuilder({resourceCollections, project, parentLogger, taskUtil}).build(tasks);
-	},
-
-	// Export type classes for extensibility
-	Builder: ApplicationBuilder,
-	Formatter: ApplicationFormatter
-};