@ui5/builder 2.10.0 → 2.11.3

package/CHANGELOG.md

@@ -2,10 +2,38 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v2.10.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v2.11.3...HEAD).
+
+<a name="v2.11.3"></a>
+## [v2.11.3] - 2021-12-12
+### Bug Fixes
+- Enable buildThemes for libraries without .library [`7b941a7`](https://github.com/SAP/ui5-builder/commit/7b941a797210463a9fa8ca50753662c5db373aa6)
+
+
+<a name="v2.11.2"></a>
+## [v2.11.2] - 2021-11-17
+### Bug Fixes
+- **Builder:** Emit warning on bundleInfo name without extension [`ed0da12`](https://github.com/SAP/ui5-builder/commit/ed0da123ac084d126a28f0f34d9740c310d91902)
+- **manifestCreator:** Trim whitespace/new-lines for sap.app/title [`019cfd7`](https://github.com/SAP/ui5-builder/commit/019cfd7031a2bd63ce93801ad027413151a3b060)
+
+
+<a name="v2.11.1"></a>
+## [v2.11.1] - 2021-10-19
+### Bug Fixes
+- Minification excludes for application projects [`7f6fd68`](https://github.com/SAP/ui5-builder/commit/7f6fd68e1aed9131896723f1231816287eaf2fce)
+
+
+<a name="v2.11.0"></a>
+## [v2.11.0] - 2021-10-19
+### Bug Fixes
+- **manifestCreator:** supportedThemes should only list relevant themes [`01f3859`](https://github.com/SAP/ui5-builder/commit/01f3859070b6955b9824b0949e633c6d40244633)
+
+### Features
+- Support build minification excludes ([#653](https://github.com/SAP/ui5-builder/issues/653)) [`0aa2301`](https://github.com/SAP/ui5-builder/commit/0aa2301df4c5d40c531da52e2d6314955b95b396)
+
 
 <a name="v2.10.0"></a>
-## [v2.10.0] - 2021-10-04
+## [v2.10.0] - 2021-10-05
 ### Features
 - Introduce build task replaceBuildtime [`2ad0960`](https://github.com/SAP/ui5-builder/commit/2ad09603deee3bc26eae36aa36a7a4ac10f83cb0)
 
@@ -611,6 +639,10 @@ to load the custom bundle file instead.
 - Add ability to configure component preloads and custom bundles [`2241e5f`](https://github.com/SAP/ui5-builder/commit/2241e5ff98fd95f1f80cc74959655ae7a9c660e7)
 
 
+[v2.11.3]: https://github.com/SAP/ui5-builder/compare/v2.11.2...v2.11.3
+[v2.11.2]: https://github.com/SAP/ui5-builder/compare/v2.11.1...v2.11.2
+[v2.11.1]: https://github.com/SAP/ui5-builder/compare/v2.11.0...v2.11.1
+[v2.11.0]: https://github.com/SAP/ui5-builder/compare/v2.10.0...v2.11.0
 [v2.10.0]: https://github.com/SAP/ui5-builder/compare/v2.9.5...v2.10.0
 [v2.9.5]: https://github.com/SAP/ui5-builder/compare/v2.9.4...v2.9.5
 [v2.9.4]: https://github.com/SAP/ui5-builder/compare/v2.9.3...v2.9.4

package/index.js

@@ -49,6 +49,10 @@ module.exports = {
 		 * @type {import('./lib/processors/libraryLessGenerator')}
 		 */
 		libraryLessGenerator: "./lib/processors/libraryLessGenerator",
+		/**
+		 * @type {import('./lib/processors/manifestCreator')}
+		 */
+		manifestCreator: "./lib/processors/manifestCreator",
 		/**
 		 * @type {import('./lib/processors/resourceCopier')}
 		 */

package/lib/builder/ProjectBuildContext.js

@@ -1,5 +1,7 @@
 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 = Object.freeze({
 	OmitFromBuildResult: "ui5:OmitFromBuildResult",
 	IsBundle: "ui5:IsBundle"

package/lib/lbt/bundle/Builder.js

@@ -2,6 +2,7 @@
 // for consistency of write calls, we generally allow template literals
 "use strict";
 
+const path = require("path");
 const terser = require("terser");
 const {pd} = require("pretty-data");
 const {parseJS, Syntax} = require("../utils/parseUtils");
@@ -486,6 +487,11 @@ class BundleBuilder {
 				if (!section.name) {
 					throw new Error(`A 'bundleInfo' section is missing the mandatory 'name' property.` );
 				}
+				if (!path.extname(section.name)) {
+					log.warn(`bundleInfo section name '${section.name}' is missing a file extension. ` +
+						`The info might not work as expected. ` +
+						`The name must match the bundle filename (incl. extension such as '.js')`);
+				}
 				this.outW.write(`"${section.name}":[${section.modules.map(makeStringLiteral).join(",")}]`);
 			});
 			this.outW.writeln();

package/lib/processors/manifestCreator.js

@@ -157,10 +157,12 @@ class LibraryBundle {
 /*
  * Creates the library manifest.json file for a UILibrary.
  */
-async function createManifest(libraryResource, libBundle, descriptorVersion, _include3rdParty) {
+async function createManifest(libraryResource, libBundle, descriptorVersion, _include3rdParty, omitMinVersions) {
 	// create a Library wrapper around the .library XML
 	const library = await Library.from(libraryResource);
 
+	const libraryPathPrefix = posixPath.dirname(libraryResource.getPath()) + "/";
+
 	// collect information from library.js file
 	const libraryJSInfo = await analyzeLibraryJS(libBundle.findResource("library.js"));
 	const includeSupportedLocalesInformation = descriptorVersion.compare(APP_DESCRIPTOR_V22) >= 0;
@@ -183,7 +185,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 	}
 
 	function createSapApp() {
-		function hasManifest(componentPath, libraryPathPrefix) {
+		function hasManifest(componentPath) {
 			const manifestPath = componentPath + "/manifest.json";
 
 			const manifestResource = libBundle.findResource(manifestPath.substring(libraryPathPrefix.length));
@@ -196,17 +198,19 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 
 		function findEmbeddedComponents() {
 			const result = [];
-			const prefix = posixPath.dirname(libraryResource.getPath()) + "/";
 			const components = libBundle.getResources(/^\/(?:[^/]+\/)*Component\.js$/);
 			for (const comp of components) {
 				const componentPath = posixPath.dirname(comp.getPath());
 				log.verbose("checking component at %s", componentPath);
-				if ( componentPath.startsWith(prefix) && hasManifest(componentPath, prefix) ) {
-					result.push( componentPath.substring(prefix.length) );
-				} else if ( prefix === "/resources/sap/apf/" ) {
+				if ( componentPath.startsWith(libraryPathPrefix) && hasManifest(componentPath) ) {
+					result.push( componentPath.substring(libraryPathPrefix.length) );
+				} else if ( libraryPathPrefix === "/resources/sap/apf/" ) {
 					log.verbose("Package %s contains both '*.library' and 'Component.js'. " +
 						"This is a known issue but can't be solved due to backward compatibility.", componentPath);
-				} else if ( prefix === (componentPath + "/") && prefix !== "/resources/sap/ui/core/" ) {
+				} else if (
+					libraryPathPrefix === (componentPath + "/") &&
+					libraryPathPrefix !== "/resources/sap/ui/core/"
+				) {
 					log.error("Package %s contains both '*.library' and 'Component.js'. " +
 						"This is not supported by manifests, therefore the component won't be " +
 						"listed in the library's manifest.", componentPath);
@@ -233,7 +237,7 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 			if ( library.getDocumentation() ) {
 				let desc = library.getDocumentation();
 				// remove all tags
-				desc = desc.replace(/\\s+/g, " ").replace(/<\/?[a-zA-Z][a-zA-Z0-9_$.]*(\s[^>]*)>/g, "");
+				desc = desc.replace(/\s+/g, " ").replace(/<\/?[a-zA-Z][a-zA-Z0-9_$.]*(\s[^>]*)>/g, "");
 				// extract summary (first sentence)
 				const m = /^([\w\W]+?[.;!?])[^a-zA-Z0-9_$]/.exec(desc);
 				return m ? m[1] : desc;
@@ -353,13 +357,17 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 
 			// find theme resources and determine theme names from their paths
 			libBundle.getResources(/(?:[^/]+\/)*themes\//).forEach((res) => {
+				if ( !res.getPath().startsWith(libraryPathPrefix + "themes/") ) {
+					// only consider themes within direct "themes" sub-directory
+					return;
+				}
 				const match = /\/themes\/([^/]+)\//.exec(res.getPath());
 				if ( match ) {
 					themes[match[1]] = true;
 				}
 			});
 
-			// merge with supporteTheme info from .library file
+			// merge with supportedTheme info from .library file
 			const elems = findChildren(manifestAppData, "supportedTheme");
 			if ( elems ) {
 				elems.forEach((elem) => {
@@ -395,14 +403,14 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 
 		function dependencies() {
 			const dependencies = {
-				minUI5Version: getUI5Version(),
+				minUI5Version: omitMinVersions ? "" : getUI5Version(),
 				libs: {
 				}
 			};
 			if ( library.getDependencies() != null ) {
 				for (const dep of library.getDependencies()) {
 					dependencies.libs[dep.getLibraryName()] = {
-						minVersion: getVersion(dep),
+						minVersion: omitMinVersions ? "" : getVersion(dep),
 						lazy: dep.isLazy() || undefined // suppress default (false)
 					};
 				}
@@ -652,9 +660,10 @@ async function createManifest(libraryResource, libBundle, descriptorVersion, _in
 module.exports = function({libraryResource, resources, options}) {
 	// merge options with defaults
 	options = Object.assign({
-		descriptorVersion: APP_DESCRIPTOR_V22, // TODO change this to type string instead of a semver object
+		descriptorVersion: APP_DESCRIPTOR_V22, // TODO 3.0: change this to type string instead of a semver object
 		include3rdParty: true,
-		prettyPrint: true
+		prettyPrint: true,
+		omitMinVersions: false
 	}, options);
 
 	const resourcePathPrefix = libraryResource.getPath().slice(0, -".library".length);
@@ -667,7 +676,8 @@ module.exports = function({libraryResource, resources, options}) {
 		return Promise.resolve(null); // a fulfillment of null indicates that no manifest has been created
 	}
 
-	return createManifest(libraryResource, libBundle, options.descriptorVersion, options.include3rdParty)
+	return createManifest(libraryResource, libBundle, options.descriptorVersion, options.include3rdParty,
+		options.omitMinVersions)
 		.then((manifest) => {
 			return new EvoResource({
 				path: resourcePathPrefix + "manifest.json",

package/lib/tasks/TaskUtil.js

@@ -20,6 +20,8 @@ class TaskUtil {
 	 * @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
 	 */
 
 	/**
@@ -147,6 +149,7 @@ class TaskUtil {
 		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}`);

package/lib/tasks/buildThemes.js

@@ -54,8 +54,12 @@ module.exports = async function({
 		*/
 	let availableLibraries;
 	if (pAvailableLibraries) {
-		availableLibraries = (await pAvailableLibraries).map((resource) => {
-			return resource.getPath().replace(/[^/]*\.library/i, "");
+		availableLibraries = [];
+		(await pAvailableLibraries).forEach((resource) => {
+			const library = path.dirname(resource.getPath());
+			if (!availableLibraries.includes(library)) {
+				availableLibraries.push(library);
+			}
 		});
 	}
 	let availableThemes;

package/lib/tasks/bundlers/generateLibraryPreload.js

@@ -280,59 +280,59 @@ module.exports = function({workspace, dependencies, taskUtil, options: {projectN
 	return combo.byGlob("/**/*.{js,json,xml,html,properties,library}").then((resources) => {
 		// Find all libraries and create a library-preload.js bundle
 
-		let p;
+		let p = Promise.resolve();
 
-		// Create sap-ui-core.js
-		// TODO: move to config of actual core project
+		// Create core bundles for older versions (<1.97.0) which don't define bundle configuration in the ui5.yaml
+		// See: https://github.com/SAP/openui5/commit/ff127fd2d009162ea43ad312dec99d759ebc23a0
 		if (projectName === "sap.ui.core") {
-			// Filter out sap-ui-core.js from further uglification/replacement processors
-			//	to prevent them from overwriting it
-			resources = resources.filter((resource) => {
-				return resource.getPath() !== "/resources/sap-ui-core.js";
-			});
-
-			const isEvo = resources.find((resource) => {
-				return resource.getPath() === "/resources/ui5loader.js";
-			});
-			let filters;
-			if (isEvo) {
-				filters = ["ui5loader-autoconfig.js"];
-			} else {
-				filters = ["jquery.sap.global.js"];
-			}
-
-			p = Promise.all([
-				moduleBundler({
-					options: getModuleBundlerOptions({name: "sap-ui-core.js", filters, preload: true}),
-					resources
-				}),
-				moduleBundler({
-					options: getModuleBundlerOptions({name: "sap-ui-core-dbg.js", filters, preload: false}),
-					resources
-				}),
-				moduleBundler({
-					options: getModuleBundlerOptions({
-						name: "sap-ui-core-nojQuery.js", filters, preload: true, provided: true
+			const coreProject = resources[0]._project;
+			const coreSpecVersion = coreProject && coreProject.specVersion;
+			// Instead of checking the sap.ui.core library version, the specVersion is checked against all versions
+			// that have been defined for sap.ui.core before the bundle configuration has been introduced.
+			// This is mainly to have an easier check without version parsing or using semver.
+			// If no project/specVersion is available, the bundles should also be created to not break potential
+			// existing use cases without a properly formed/formatted project tree.
+			if (!coreSpecVersion || ["0.1", "1.1", "2.0"].includes(coreSpecVersion)) {
+				const isEvo = resources.find((resource) => {
+					return resource.getPath() === "/resources/ui5loader.js";
+				});
+				let filters;
+				if (isEvo) {
+					filters = ["ui5loader-autoconfig.js"];
+				} else {
+					filters = ["jquery.sap.global.js"];
+				}
+				p = Promise.all([
+					moduleBundler({
+						options: getModuleBundlerOptions({name: "sap-ui-core.js", filters, preload: true}),
+						resources
 					}),
-					resources
-				}),
-				moduleBundler({
-					options: getModuleBundlerOptions({
-						name: "sap-ui-core-nojQuery-dbg.js", filters, preload: false, provided: true
+					moduleBundler({
+						options: getModuleBundlerOptions({name: "sap-ui-core-dbg.js", filters, preload: false}),
+						resources
 					}),
-					resources
-				}),
-			]).then((results) => {
-				const bundles = Array.prototype.concat.apply([], results);
-				return Promise.all(bundles.map((bundle) => {
-					if (taskUtil) {
-						taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
-					}
-					return workspace.write(bundle);
-				}));
-			});
-		} else {
-			p = Promise.resolve();
+					moduleBundler({
+						options: getModuleBundlerOptions({
+							name: "sap-ui-core-nojQuery.js", filters, preload: true, provided: true
+						}),
+						resources
+					}),
+					moduleBundler({
+						options: getModuleBundlerOptions({
+							name: "sap-ui-core-nojQuery-dbg.js", filters, preload: false, provided: true
+						}),
+						resources
+					}),
+				]).then((results) => {
+					const bundles = Array.prototype.concat.apply([], results);
+					return Promise.all(bundles.map((bundle) => {
+						if (taskUtil) {
+							taskUtil.setTag(bundle, taskUtil.STANDARD_TAGS.IsBundle);
+						}
+						return workspace.write(bundle);
+					}));
+				});
+			}
 		}
 
 		return p.then(() => {

package/lib/tasks/generateResourcesJson.js

@@ -24,19 +24,7 @@ function getCreatorOptions(projectName) {
 					"sap/base/",
 					"sap/ui/"
 				]
-			},
-			mergedResourcesFilters: [
-				"jquery-sap*.js",
-				"sap-ui-core*.js",
-				"**/Component-preload.js",
-				"**/library-preload.js",
-				"**/library-preload-dbg.js",
-				"**/library-preload.json",
-				"**/library-all.js",
-				"**/library-all-dbg.js",
-				"**/designtime/library-preload.designtime.js",
-				"**/library-preload.support.js"
-			]
+			}
 		});
 	} else if ( projectName === "sap.ui.integration" ) {
 		Object.assign(creatorOptions, {

package/lib/types/AbstractBuilder.js

@@ -242,6 +242,29 @@ class AbstractBuilder {
 			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/application/ApplicationBuilder.js

@@ -138,12 +138,22 @@ class ApplicationBuilder extends AbstractBuilder {
 			});
 		}
 
+		const minificationPattern = ["/**/*.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("createDebugFiles", async () => {
 			const createDebugFiles = getTask("createDebugFiles").task;
 			return createDebugFiles({
 				workspace: resourceCollections.workspace,
 				options: {
-					pattern: "/**/*.js"
+					pattern: minificationPattern
 				}
 			});
 		});
@@ -154,7 +164,7 @@ class ApplicationBuilder extends AbstractBuilder {
 				workspace: resourceCollections.workspace,
 				taskUtil,
 				options: {
-					pattern: "/**/*.js"
+					pattern: minificationPattern
 				}
 			});
 		});

package/lib/types/library/LibraryBuilder.js

@@ -176,7 +176,7 @@ class LibraryBuilder extends AbstractBuilder {
 				dependencies: resourceCollections.dependencies,
 				options: {
 					projectName: project.metadata.name,
-					librariesPattern: !taskUtil.isRootProject() ? "/resources/**/*.library" : undefined,
+					librariesPattern: !taskUtil.isRootProject() ? "/resources/**/(*.library|library.js)" : undefined,
 					themesPattern: !taskUtil.isRootProject() ? "/resources/sap/ui/core/themes/*" : undefined,
 					inputPattern
 				}
@@ -195,11 +195,19 @@ class LibraryBuilder extends AbstractBuilder {
 			});
 		});
 
+		const minificationPattern = ["/resources/**/*.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("createDebugFiles", async () => {
 			return getTask("createDebugFiles").task({
 				workspace: resourceCollections.workspace,
 				options: {
-					pattern: "/resources/**/*.js"
+					pattern: minificationPattern
 				}
 			});
 		});
@@ -209,7 +217,7 @@ class LibraryBuilder extends AbstractBuilder {
 				workspace: resourceCollections.workspace,
 				taskUtil,
 				options: {
-					pattern: "/resources/**/*.js"
+					pattern: minificationPattern
 				}
 			});
 		});

package/lib/types/themeLibrary/ThemeLibraryBuilder.js

@@ -29,7 +29,7 @@ class ThemeLibraryBuilder extends AbstractBuilder {
 				dependencies: resourceCollections.dependencies,
 				options: {
 					projectName: project.metadata.name,
-					librariesPattern: !taskUtil.isRootProject() ? "/resources/**/*.library" : undefined,
+					librariesPattern: !taskUtil.isRootProject() ? "/resources/**/(*.library|library.js)" : undefined,
 					themesPattern: !taskUtil.isRootProject() ? "/resources/sap/ui/core/themes/*" : undefined,
 					inputPattern: "/resources/**/themes/*/library.source.less"
 				}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "2.10.0",
+	"version": "2.11.3",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -120,7 +120,7 @@
 		"replacestream": "^4.0.3",
 		"rimraf": "^3.0.2",
 		"semver": "^7.3.5",
-		"terser": "^5.9.0",
+		"terser": "^5.10.0",
 		"xml2js": "^0.4.23",
 		"yazl": "^2.5.1"
 	},
@@ -134,7 +134,7 @@
 		"docdash": "^1.2.0",
 		"eslint": "^7.32.0",
 		"eslint-config-google": "^0.14.0",
-		"eslint-plugin-jsdoc": "^36.1.0",
+		"eslint-plugin-jsdoc": "^37.2.0",
 		"extract-zip": "^2.0.1",
 		"mock-require": "^3.0.3",
 		"nyc": "^15.1.0",