@ui5/builder 3.0.0-alpha.0 → 3.0.0-alpha.3

package/CHANGELOG.md

@@ -2,7 +2,61 @@
 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/v3.0.0-alpha.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.3...HEAD).
+
+<a name="v3.0.0-alpha.3"></a>
+## [v3.0.0-alpha.3] - 2022-03-10
+### Bug Fixes
+- **LocatorResourcePool:** Wait for resources in prepare step ([#719](https://github.com/SAP/ui5-builder/issues/719)) [`1b7f93f`](https://github.com/SAP/ui5-builder/commit/1b7f93f4988340d7a6575be3191a02e6c295ebd0)
+
+
+<a name="v3.0.0-alpha.2"></a>
+## [v3.0.0-alpha.2] - 2022-02-25
+### Bug Fixes
+- **XMLTemplateAnalyzer:** Analyze core:require of FragmentDefinition [`af075ed`](https://github.com/SAP/ui5-builder/commit/af075edf784d9f1ba162a34f0bf150dbcbc0f479)
+
+### Features
+- Generate source maps for bundles ([#695](https://github.com/SAP/ui5-builder/issues/695)) [`8a20c42`](https://github.com/SAP/ui5-builder/commit/8a20c4257a1ebe4d613b0595be93cd45d900f580)
+- **replaceVersion/Copyright:** Also process test-resources ([#693](https://github.com/SAP/ui5-builder/issues/693)) [`a0d4bc2`](https://github.com/SAP/ui5-builder/commit/a0d4bc2a80d61e042786207af4bdbda6c3ddfe31)
+
+
+<a name="v3.0.0-alpha.1"></a>
+## [v3.0.0-alpha.1] - 2022-01-25
+### Breaking Changes
+- Require Node.js >= 16.13.2 / npm >= 8 [`dbf6c06`](https://github.com/SAP/ui5-builder/commit/dbf6c0694693070f73e9f96edef90f094d5bf721)
+- **generateResourcesJson:** Make 'dependencies' parameter mandatory [`268dd16`](https://github.com/SAP/ui5-builder/commit/268dd16091c515ec0c922ea23af437d9aa8bf3ea)
+- **moduleBundler:** Always default to `optimize: true` ([#685](https://github.com/SAP/ui5-builder/issues/685)) [`de5837c`](https://github.com/SAP/ui5-builder/commit/de5837c43449ea61deae3b2f02f9973f3fa37992)
+
+### Bug Fixes
+- **Bundler:** Ensure reproducibility for bundles with multiple parts ([#689](https://github.com/SAP/ui5-builder/issues/689)) [`6f4588b`](https://github.com/SAP/ui5-builder/commit/6f4588b3eb687178e557ac4fb36481104f9681a0)
+- **generateResourcesJson:** Don't list resources omitted from build result [`9608c51`](https://github.com/SAP/ui5-builder/commit/9608c5177f86494ba689d2e799b4378fec9ed6fa)
+- **generateResourcesJson:** Analyze debug bundles ([#669](https://github.com/SAP/ui5-builder/issues/669)) [`f27513a`](https://github.com/SAP/ui5-builder/commit/f27513a259b30d39e260790781b6d435b4ab088b)
+
+### Features
+- Support ES2021 language features [`e749b6a`](https://github.com/SAP/ui5-builder/commit/e749b6ae0838f923b27dd0d7d34da2174c433f5f)
+- Add minify task and processor ([#666](https://github.com/SAP/ui5-builder/issues/666)) [`a3af604`](https://github.com/SAP/ui5-builder/commit/a3af604ff0a12fb9241dcd105cf0aec8d718a299)
+
+### BREAKING CHANGE
+
+Support for older Node.js and npm releases has been dropped.
+Only Node.js v16.13.2 and npm v8 or higher are supported.
+
+The following tasks have been removed:
+- createDebugFiles
+- uglify
+
+The following processors have been removed:
+- debugFileCreator
+- resourceCopier
+- uglifier
+
+As a replacement, the new 'minify' task and 'minifier' processor can be
+used.
+
+Note: The minify task is executed earlier, before the bundling
+process takes place. Existing 'beforeTask' and 'afterTask' configuration of
+custom tasks might need to be adapted to cater for this change.
+
 
 <a name="v3.0.0-alpha.0"></a>
 ## [v3.0.0-alpha.0] - 2021-12-14
@@ -639,6 +693,9 @@ 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)
 
 
+[v3.0.0-alpha.3]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.2...v3.0.0-alpha.3
+[v3.0.0-alpha.2]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.1...v3.0.0-alpha.2
+[v3.0.0-alpha.1]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.0...v3.0.0-alpha.1
 [v3.0.0-alpha.0]: https://github.com/SAP/ui5-builder/compare/v2.11.2...v3.0.0-alpha.0
 [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

package/index.js

@@ -42,9 +42,9 @@ module.exports = {
 		 */
 		bootstrapHtmlTransformer: "./lib/processors/bootstrapHtmlTransformer",
 		/**
-		 * @type {import('./lib/processors/debugFileCreator')}
+		 * @type {import('./lib/processors/minifier')}
 		 */
-		debugFileCreator: "./lib/processors/debugFileCreator",
+		minifier: "./lib/processors/minifier",
 		/**
 		 * @type {import('./lib/processors/libraryLessGenerator')}
 		 */
@@ -53,10 +53,6 @@ module.exports = {
 		 * @type {import('./lib/processors/manifestCreator')}
 		 */
 		manifestCreator: "./lib/processors/manifestCreator",
-		/**
-		 * @type {import('./lib/processors/resourceCopier')}
-		 */
-		resourceCopier: "./lib/processors/resourceCopier",
 		/**
 		 * @type {import('./lib/processors/nonAsciiEscaper')}
 		 */
@@ -69,10 +65,6 @@ module.exports = {
 		 * @type {import('./lib/processors/themeBuilder')}
 		 */
 		themeBuilder: "./lib/processors/themeBuilder",
-		/**
-		 * @type {import('./lib/processors/uglifier')}
-		 */
-		uglifier: "./lib/processors/uglifier",
 		/**
 		 * @type {import('./lib/processors/versionInfoGenerator')}
 		 */
@@ -121,9 +113,9 @@ module.exports = {
 		 */
 		buildThemes: "./lib/tasks/buildThemes",
 		/**
-		 * @type {import('./lib/tasks/createDebugFiles')}
+		 * @type {import('./lib/tasks/minify')}
 		 */
-		createDebugFiles: "./lib/tasks/createDebugFiles",
+		minify: "./lib/tasks/minify",
 		/**
 		 * @type {import('./lib/tasks/jsdoc/executeJsdocSdkTransformation')}
 		 */
@@ -160,10 +152,6 @@ module.exports = {
 		 * @type {import('./lib/tasks/transformBootstrapHtml')}
 		 */
 		transformBootstrapHtml: "./lib/tasks/transformBootstrapHtml",
-		/**
-		 * @type {import('./lib/tasks/uglify')}
-		 */
-		uglify: "./lib/tasks/uglify",
 		/**
 		 * @type {import('./lib/tasks/taskRepository')}
 		 */

package/jsdoc.json

@@ -12,7 +12,6 @@
 		"./jsdoc-plugin"
 	],
 	"opts": {
-		"template": "node_modules/docdash/",
 		"encoding": "utf8",
 		"destination": "jsdocs/",
 		"recurse": true,

package/lib/builder/BuildContext.js

@@ -1,5 +1,13 @@
+const ResourceTagCollection = require("@ui5/fs").ResourceTagCollection;
 const ProjectBuildContext = require("./ProjectBuildContext");
 
+// Note: When adding standard tags, always update the public documentation in TaskUtil
+// (Type "module:@ui5/builder.tasks.TaskUtil~StandardBuildTags")
+const GLOBAL_TAGS = Object.freeze({
+	IsDebugVariant: "ui5:IsDebugVariant",
+	HasDebugVariant: "ui5:HasDebugVariant",
+});
+
 /**
  * Context of a build process
  *
@@ -13,6 +21,10 @@ class BuildContext {
 		}
 		this.rootProject = rootProject;
 		this.projectBuildContexts = [];
+
+		this._resourceTagCollection = new ResourceTagCollection({
+			allowedTags: Object.values(GLOBAL_TAGS)
+		});
 	}
 
 	getRootProject() {
@@ -22,6 +34,7 @@ class BuildContext {
 	createProjectContext({project, resources}) {
 		const projectBuildContext = new ProjectBuildContext({
 			buildContext: this,
+			globalTags: GLOBAL_TAGS,
 			project,
 			resources
 		});
@@ -34,6 +47,10 @@ class BuildContext {
 			return ctx.executeCleanupTasks();
 		}));
 	}
+
+	getResourceTagCollection() {
+		return this._resourceTagCollection;
+	}
 }
 
 module.exports = BuildContext;

package/lib/builder/ProjectBuildContext.js

@@ -2,10 +2,10 @@ 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({
+const STANDARD_TAGS = {
 	OmitFromBuildResult: "ui5:OmitFromBuildResult",
-	IsBundle: "ui5:IsBundle"
-});
+	IsBundle: "ui5:IsBundle",
+};
 
 /**
  * Build context of a single project. Always part of an overall
@@ -15,8 +15,8 @@ const STANDARD_TAGS = Object.freeze({
  * @memberof module:@ui5/builder.builder
  */
 class ProjectBuildContext {
-	constructor({buildContext, project, resources}) {
-		if (!buildContext || !project || !resources) {
+	constructor({buildContext, globalTags, project, resources}) {
+		if (!buildContext || !globalTags || !project || !resources) {
 			throw new Error(`One or more mandatory parameters are missing`);
 		}
 		this._buildContext = buildContext;
@@ -26,10 +26,12 @@ class ProjectBuildContext {
 			cleanup: []
 		};
 
-		this.STANDARD_TAGS = STANDARD_TAGS;
+		this.STANDARD_TAGS = Object.assign({}, STANDARD_TAGS, globalTags);
+		Object.freeze(this.STANDARD_TAGS);
 
 		this._resourceTagCollection = new ResourceTagCollection({
-			allowedTags: Object.values(this.STANDARD_TAGS)
+			allowedTags: Object.values(this.STANDARD_TAGS),
+			superCollection: this._buildContext.getResourceTagCollection()
 		});
 	}
 

package/lib/builder/builder.js

@@ -94,8 +94,7 @@ function composeTaskList({dev, selfContained, jsdoc, includedTasks, excludedTask
 		selectedTasks.generateComponentPreload = false;
 		selectedTasks.generateLibraryPreload = false;
 		selectedTasks.generateLibraryManifest = false;
-		selectedTasks.createDebugFiles = false;
-		selectedTasks.uglify = false;
+		selectedTasks.minify = false;
 		selectedTasks.generateFlexChangesBundle = false;
 		selectedTasks.generateManifestBundle = false;
 	}

package/lib/lbt/analyzer/JSModuleAnalyzer.js

@@ -64,6 +64,7 @@ const EnrichedVisitorKeys = (function() {
 		BreakStatement: [],
 		CallExpression: [], // special handling
 		CatchClause: ["param", "body"],
+		ChainExpression: [],
 		ClassBody: [],
 		ClassDeclaration: [],
 		ClassExpression: [],
@@ -125,8 +126,10 @@ const EnrichedVisitorKeys = (function() {
 		 * All properties in an object pattern are executed.
 		 */
 		ObjectPattern: [], // properties
+		// PrivateIdentifier: [], // will come with ES2022
 		Program: [],
 		Property: [],
+		// PropertyDefinition: [], // will come with ES2022
 		/*
 		 * argument of the rest element is always executed under the same condition as the rest element itself
 		 */
@@ -134,6 +137,7 @@ const EnrichedVisitorKeys = (function() {
 		ReturnStatement: [],
 		SequenceExpression: [],
 		SpreadElement: [], // the argument of the spread operator always needs to be evaluated - argument
+		// StaticBlock: [], // will come with ES2022
 		Super: [],
 		SwitchStatement: [],
 		SwitchCase: ["test", "consequent"], // test and consequent are executed only conditionally
@@ -171,9 +175,11 @@ const EnrichedVisitorKeys = (function() {
 
 	// merge with 'official' visitor keys
 	Object.keys(VisitorKeys).forEach( (type) => {
-		// Check if the visitor-key exists in the available Syntax because
-		// the list of visitor-keys does not match the available Syntax.
-		if (!Syntax[type]) {
+		// Ignore deprecated keys:
+		// - ExperimentalSpreadProperty => SpreadElement
+		// - ExperimentalRestProperty => RestElement
+		// They are about to be removed, see: https://github.com/eslint/eslint-visitor-keys/pull/36
+		if (type === "ExperimentalSpreadProperty" || type === "ExperimentalRestProperty") {
 			return;
 		}
 		// Ignore JSX visitor-keys because they aren't used.
@@ -181,6 +187,15 @@ const EnrichedVisitorKeys = (function() {
 			return;
 		}
 
+		// Ignore new ES2022 syntax as we currently use ES2021 (see parseUtils.js)
+		if (
+			type === "PrivateIdentifier" ||
+			type === "PropertyDefinition" ||
+			type === "StaticBlock"
+		) {
+			return;
+		}
+
 		const visitorKeys = VisitorKeys[type];
 		const condKeys = TempKeys[type];
 		if ( condKeys === undefined ) {

package/lib/lbt/analyzer/XMLTemplateAnalyzer.js

@@ -231,9 +231,10 @@ class XMLTemplateAnalyzer {
 			// looks like a UI5 library or package name
 			const moduleName = ModuleName.fromUI5LegacyName( (namespace ? namespace + "." : "") + localName );
 
+			this._analyzeCoreRequire(node);
+
 			// ignore FragmentDefinition (also skipped by runtime XMLTemplateProcessor)
 			if ( FRAGMENTDEFINITION_MODULE !== moduleName ) {
-				this._analyzeCoreRequire(node);
 				this.promises.push(this._analyzeModuleDependency(node, moduleName, this.conditional));
 			}
 		}

package/lib/lbt/bundle/AutoSplitter.js

@@ -1,6 +1,5 @@
 "use strict";
 
-const terser = require("terser");
 const {pd} = require("pretty-data");
 
 const ModuleName = require("../utils/ModuleName");
@@ -8,7 +7,6 @@ const {SectionType} = require("./BundleDefinition");
 const escapePropertiesFile = require("../utils/escapePropertiesFile");
 const log = require("@ui5/logger").getLogger("lbt:bundle:AutoSplitter");
 
-const copyrightCommentsPattern = /copyright|\(c\)(?:[0-9]+|\s+[0-9A-za-z])|released under|license|\u00a9/i;
 const xmlHtmlPrePattern = /<(?:\w+:)?pre\b/;
 
 /**
@@ -112,6 +110,7 @@ class AutoSplitter {
 
 		resolvedModule.sections.forEach( (section) => {
 			let currentSection;
+			let sequence;
 			switch ( section.mode ) {
 			case SectionType.Provided:
 				// 'provided' sections are no longer needed in a fully resolved module
@@ -131,16 +130,20 @@ class AutoSplitter {
 				});
 				break;
 			case SectionType.Preload:
+				sequence = section.modules.slice();
+				// simple version: just sort alphabetically
+				sequence.sort();
+
 				// NODE_TODO: sort by copyright:
-				// sequence = section.modules.slice();
 				// jsBuilder.beforeWriteFunctionPreloadSection((List<ModuleName>) sequence);
+
 				currentSection = {
 					mode: SectionType.Preload,
 					filters: []
 				};
 				currentSection.name = section.name;
 				currentModule.sections.push( currentSection );
-				section.modules.forEach( (module) => {
+				sequence.forEach( (module) => {
 					const moduleSize = moduleSizes[module];
 					if ( part + 1 < numberOfParts && totalSize + moduleSize / 2 > partSize ) {
 						part++;
@@ -195,26 +198,9 @@ class AutoSplitter {
 			}
 
 			if ( /\.js$/.test(module) ) {
-				// console.log("determining compressed size for %s", module);
-				let fileContent = await resource.buffer();
-				if ( this.optimize ) {
-					// console.log("uglify %s start", module);
-					const result = await terser.minify({
-						[resource.name]: String(fileContent)
-					}, {
-						warnings: false, // TODO configure?
-						compress: false, // TODO configure?
-						output: {
-							comments: copyrightCommentsPattern,
-							wrap_func_args: false
-						}
-						// , outFileName: resource.name
-						// , outSourceMap: true
-					});
-					// console.log("uglify %s end", module);
-					fileContent = result.code;
-				}
-				// trace.debug("analyzed %s:%d%n", module, mw.getTargetLength());
+				// No optimize / minify step here as the input should be
+				// either already optimized or not, based on the bundle options
+				const fileContent = await resource.buffer();
 				return fileContent.length;
 			} else if ( /\.properties$/.test(module) ) {
 				/* NODE-TODO minimize *.properties