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

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
-};

package/lib/types/library/LibraryBuilder.js

@@ -1,231 +0,0 @@
-const AbstractBuilder = require("../AbstractBuilder");
-const {getTask} = require("../../tasks/taskRepository");
-
-class LibraryBuilder extends AbstractBuilder {
-	addStandardTasks({resourceCollections, project, log, taskUtil}) {
-		if (!project.metadata.namespace) {
-			// TODO 3.0: Throw here
-			log.info("Skipping some tasks due to missing library namespace information. Your project " +
-				"might be missing a manifest.json or .library file. " +
-				"Also see: https://sap.github.io/ui5-tooling/pages/Builder/#library");
-		}
-
-		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: "/resources/**/*.{js,library,less,theme}"
-				}
-			});
-		});
-
-		this.addTask("replaceVersion", async () => {
-			return getTask("replaceVersion").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					version: project.version,
-					pattern: "/resources/**/*.{js,json,library,less,theme}"
-				}
-			});
-		});
-
-		this.addTask("replaceBuildtime", async () => {
-			return getTask("replaceBuildtime").task({
-				workspace: resourceCollections.workspace,
-				options: {
-					pattern: "/resources/sap/ui/Global.js"
-				}
-			});
-		});
-
-		if (project.metadata.namespace) {
-			this.addTask("generateJsdoc", async () => {
-				const patterns = ["/resources/**/*.js"];
-				// Add excludes
-				if (project.builder && project.builder.jsdoc && project.builder.jsdoc.excludes) {
-					const excludes = project.builder.jsdoc.excludes.map((pattern) => {
-						return `!/resources/${pattern}`;
-					});
-
-					patterns.push(...excludes);
-				}
-
-				return getTask("generateJsdoc").task({
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					taskUtil,
-					options: {
-						projectName: project.metadata.name,
-						namespace: project.metadata.namespace,
-						version: project.version,
-						pattern: patterns
-					}
-				});
-			});
-
-			this.addTask("executeJsdocSdkTransformation", async () => {
-				return getTask("executeJsdocSdkTransformation").task({
-					workspace: resourceCollections.workspace,
-					dependencies: resourceCollections.dependencies,
-					options: {
-						projectName: project.metadata.name,
-						dotLibraryPattern: "/resources/**/*.library",
-					}
-				});
-			});
-		}
-
-		// Support rules should not be minified to have readable code in the Support Assistant
-		const minificationPattern = ["/resources/**/*.js", "!**/*.support.js"];
-		if (["2.6"].includes(project.specVersion)) {
-			const minificationExcludes = project.builder && project.builder.minification &&
-				project.builder.minification.excludes;
-			if (minificationExcludes) {
-				this.enhancePatternWithExcludes(minificationPattern, minificationExcludes, "/resources/");
-			}
-		}
-
-		this.addTask("minify", async () => {
-			return getTask("minify").task({
-				workspace: resourceCollections.workspace,
-				taskUtil,
-				options: {
-					pattern: minificationPattern
-				}
-			});
-		});
-
-		const componentPreload = project.builder && project.builder.componentPreload;
-		if (componentPreload) {
-			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
-					}
-				});
-			});
-		}
-
-		this.addTask("generateLibraryManifest", async () => {
-			return getTask("generateLibraryManifest").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				taskUtil,
-				options: {
-					projectName: project.metadata.name
-				}
-			});
-		});
-
-
-		if (project.metadata.namespace) {
-			this.addTask("generateManifestBundle", async () => {
-				return getTask("generateManifestBundle").task({
-					workspace: resourceCollections.workspace,
-					options: {
-						projectName: project.metadata.name,
-						namespace: project.metadata.namespace
-					}
-				});
-			});
-		}
-
-		this.addTask("generateLibraryPreload", async () => {
-			return getTask("generateLibraryPreload").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				taskUtil,
-				options: {
-					projectName: project.metadata.name,
-					excludes:
-						project.builder &&
-						project.builder.libraryPreload &&
-						project.builder.libraryPreload.excludes
-				}
-			});
-		});
-
-		const bundles = project.builder && project.builder.bundles;
-		if (bundles) {
-			this.addTask("generateBundle", async () => {
-				return bundles.reduce(function(sequence, bundle) {
-					return sequence.then(function() {
-						return getTask("generateBundle").task({
-							workspace: resourceCollections.workspace,
-							dependencies: resourceCollections.dependencies,
-							taskUtil,
-							options: {
-								projectName: project.metadata.name,
-								bundleDefinition: bundle.bundleDefinition,
-								bundleOptions: bundle.bundleOptions
-							}
-						});
-					});
-				}, Promise.resolve());
-			});
-		}
-
-		this.addTask("buildThemes", async () => {
-			// Only compile themes directly below the lib namespace to be in sync with the theme support at runtime
-			// which only loads themes from that folder.
-			// TODO 3.0: Remove fallback in case of missing namespace
-			const inputPattern = `/resources/${project.metadata.namespace || "**"}/themes/*/library.source.less`;
-
-			return getTask("buildThemes").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				options: {
-					projectName: project.metadata.name,
-					librariesPattern: !taskUtil.isRootProject() ? "/resources/**/(*.library|library.js)" : undefined,
-					themesPattern: !taskUtil.isRootProject() ? "/resources/sap/ui/core/themes/*" : undefined,
-					inputPattern
-				}
-			});
-		});
-
-		this.addTask("generateThemeDesignerResources", async () => {
-			return getTask("generateThemeDesignerResources").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				options: {
-					projectName: project.metadata.name,
-					version: project.version,
-					namespace: project.metadata.namespace
-				}
-			});
-		});
-
-		this.addTask("generateResourcesJson", () => {
-			return getTask("generateResourcesJson").task({
-				workspace: resourceCollections.workspace,
-				dependencies: resourceCollections.dependencies,
-				taskUtil,
-				options: {
-					projectName: project.metadata.name
-				}
-			});
-		});
-	}
-}
-
-module.exports = LibraryBuilder;