@ui5/builder 3.0.0-alpha.9 → 3.0.0-beta.2

package/.reuse/dep5

@@ -25,9 +25,9 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
  parties the right to use of access any SAP External Product, through API Calls.
 
 Files: *
-Copyright: 2018-2020 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+Copyright: 2018-2022 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 License: Apache-2.0
 
 Files: lib/processors/jsdoc/lib/*
-Copyright: 2009-2020 SAP SE or an SAP affiliate company and OpenUI5 contributors
+Copyright: 2009-2022 SAP SE or an SAP affiliate company and OpenUI5 contributors
 License: Apache-2.0

package/CHANGELOG.md

@@ -2,7 +2,60 @@
 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.9...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.2...HEAD).
+
+<a name="v3.0.0-beta.2"></a>
+## [v3.0.0-beta.2] - 2022-11-17
+### Breaking Changes
+- Removal of manifestBundler and generateManifestBundle ([#838](https://github.com/SAP/ui5-builder/issues/838)) [`07a5be2`](https://github.com/SAP/ui5-builder/commit/07a5be2b6d9aa23cf78ddd17951c832d6dec7bef)
+- **JSDoc:** Fail build when jsdoc command failed ([#845](https://github.com/SAP/ui5-builder/issues/845)) [`c2916b4`](https://github.com/SAP/ui5-builder/commit/c2916b4f1d49b5500e4b51143d4e6065ac200eef)
+
+### Features
+- Support ES2022 language features ([#848](https://github.com/SAP/ui5-builder/issues/848)) [`f9b8457`](https://github.com/SAP/ui5-builder/commit/f9b845726731a0e02ec4a499e2a1a82a639174a8)
+
+### BREAKING CHANGE
+
+The `jsdocGenerator` processor and the corresponding `generateJsdoc` task will now throw an error when JSDoc reports an error (exit code != 0). This will also fail the build when running `ui5 build jsdoc`.
+
+The manifestBundler processor and generateManifestBundle task has been removed because it is no longer required for the HTML5 repository in Cloud Foundry.
+
+
+<a name="v3.0.0-beta.1"></a>
+## [v3.0.0-beta.1] - 2022-11-07
+
+<a name="v3.0.0-alpha.12"></a>
+## [v3.0.0-alpha.12] - 2022-10-24
+### Breaking Changes
+- Transform to native ESM ([#790](https://github.com/SAP/ui5-builder/issues/790)) [`a439aa9`](https://github.com/SAP/ui5-builder/commit/a439aa9f679dfe2e18b8c540f54876f94c0de119)
+
+### BREAKING CHANGE
+
+This package has been transformed to native ESM. Therefore it no longer provides a CommonJS export.
+If your project uses CommonJS, it needs to be converted to ESM or use a dynamic import.
+
+For more information see also:
+- https://sap.github.io/ui5-tooling/updates/migrate-v3/
+- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+
+<a name="v3.0.0-alpha.11"></a>
+## [v3.0.0-alpha.11] - 2022-10-20
+### Bug Fixes
+- **package.json:** Downgrade es5-ext dependency [`2b71707`](https://github.com/SAP/ui5-builder/commit/2b71707683480b26aab9957c09e5d22bce8a6450)
+
+### Dependency Updates
+- Bump escope from 3.6.0 to 4.0.0 [`e25af0d`](https://github.com/SAP/ui5-builder/commit/e25af0d9c1184916aa037b4b4ca23d15c5f2a408)
+
+### Features
+- **builder:** Improve support for ES6+ syntax  ([#774](https://github.com/SAP/ui5-builder/issues/774)) [`90385fe`](https://github.com/SAP/ui5-builder/commit/90385feb7cea1e5b864cff035b01263a492972a9)
+- **jsdoc:** Improve support for ES6+ syntax  ([#785](https://github.com/SAP/ui5-builder/issues/785)) [`187a6a3`](https://github.com/SAP/ui5-builder/commit/187a6a35000145d70bf41e0d8b724e5ea8d8dc78)
+
+### Reverts
+- [FIX] package.json: Downgrade es5-ext dependency
+
+
+<a name="v3.0.0-alpha.10"></a>
+## [v3.0.0-alpha.10] - 2022-08-09
 
 <a name="v3.0.0-alpha.9"></a>
 ## [v3.0.0-alpha.9] - 2022-07-27
@@ -750,6 +803,11 @@ 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-beta.2]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.1...v3.0.0-beta.2
+[v3.0.0-beta.1]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.12...v3.0.0-beta.1
+[v3.0.0-alpha.12]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.11...v3.0.0-alpha.12
+[v3.0.0-alpha.11]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.10...v3.0.0-alpha.11
+[v3.0.0-alpha.10]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.9...v3.0.0-alpha.10
 [v3.0.0-alpha.9]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.8...v3.0.0-alpha.9
 [v3.0.0-alpha.8]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.7...v3.0.0-alpha.8
 [v3.0.0-alpha.7]: https://github.com/SAP/ui5-builder/compare/v3.0.0-alpha.6...v3.0.0-alpha.7

package/CONTRIBUTING.md

@@ -1,3 +1,3 @@
 # Contributing to the UI5 Tooling
 
-See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md) repository.
+See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md) repository.

package/README.md

@@ -1,11 +1,11 @@
-![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/master/docs/images/UI5_logo_wide.png)
+![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/main/docs/images/UI5_logo_wide.png)
 
 # ui5-builder
 > Modules for building UI5 projects  
 > Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling)
 
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-builder)](https://api.reuse.software/info/github.com/SAP/ui5-builder)
-[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-builder?branchName=master)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=26&branchName=master)
+[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-builder?branchName=main)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=26&branchName=main)
 [![npm Package Version](https://badge.fury.io/js/%40ui5%2Fbuilder.svg)](https://www.npmjs.com/package/@ui5/builder)
 [![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-builder/badge.svg)](https://coveralls.io/github/SAP/ui5-builder)
 
@@ -13,10 +13,10 @@
 Can be found here: [sap.github.io/ui5-tooling](https://sap.github.io/ui5-tooling/pages/Builder/)
 
 ## Contributing
-Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md).
+Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md).
 
 ## Support
-Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/master/CONTRIBUTING.md#report-an-issue) on how to report an issue.
+Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md#report-an-issue) on how to report an issue.
 
 Please report issues in the main [UI5 Tooling](https://github.com/SAP/ui5-tooling) repository.
 

package/jsdoc.json

@@ -3,13 +3,13 @@
 		"allowUnknownTags": false
 	},
 	"source": {
-		"include": ["README.md", "index.js"],
+		"include": ["README.md"],
 		"exclude": ["lib/lbt/utils/JSTokenizer.js"],
 		"includePattern": ".+\\.js$",
 		"excludePattern": "(node_modules(\\\\|/))"
 	},
 	"plugins": [
-		"./jsdoc-plugin"
+		"./jsdoc-plugin.cjs"
 	],
 	"opts": {
 		"encoding": "utf8",

package/lib/lbt/UI5ClientConstants.js

@@ -1,13 +1,12 @@
-"use strict";
 
-module.exports.MODULE__UI5LOADER = "ui5loader.js";
-module.exports.MODULE__UI5LOADER_AUTOCONFIG = "ui5loader-autoconfig.js";
-module.exports.MODULE__JQUERY_SAP_GLOBAL = "jquery.sap.global.js";
-module.exports.MODULE__SAP_UI_CORE_CORE = "sap/ui/core/Core.js";
-module.exports.EVO_MARKER_RESOURCE = module.exports.MODULE__UI5LOADER;
+export const MODULE__UI5LOADER = "ui5loader.js";
+export const MODULE__UI5LOADER_AUTOCONFIG = "ui5loader-autoconfig.js";
+export const MODULE__JQUERY_SAP_GLOBAL = "jquery.sap.global.js";
+export const MODULE__SAP_UI_CORE_CORE = "sap/ui/core/Core.js";
+export const EVO_MARKER_RESOURCE = MODULE__UI5LOADER;
 
-module.exports.getRendererName = function( module ) {
+export function getRendererName( module ) {
 	if ( /\.js$/.test(module) ) {
 		return module.replace(/\.js$/, "Renderer.js");
 	}
-};
+}

package/lib/lbt/analyzer/ComponentAnalyzer.js

@@ -18,10 +18,10 @@
  * This class can handle multiple concurrent analysis calls, it has no instance state
  * other than the pool (which is readonly).
  */
-"use strict";
 
-const ModuleName = require("../utils/ModuleName");
-const log = require("@ui5/logger").getLogger("lbt:analyzer:ComponentAnalyzer");
+import {fromUI5LegacyName} from "../utils/ModuleName.js";
+import logger from "@ui5/logger";
+const log = logger.getLogger("lbt:analyzer:ComponentAnalyzer");
 
 // ---------------------------------------------------------------------------------------------------------
 
@@ -66,6 +66,53 @@ class ComponentAnalyzer {
 		return info;
 	}
 
+	_getRootViewModule(rootView) {
+		// For runtime logic see sap/ui/core/UIComponent#createContent and sap/ui/core/mvc/View#_getModuleName
+
+		if (typeof rootView === "string") {
+			rootView = {
+				viewName: rootView
+			};
+		}
+		if (!rootView.type) {
+			rootView.type = "XML";
+		}
+
+		if (!rootView.viewName) {
+			log.warn(`Unable to analyze sap.ui5/rootView: Missing viewName`);
+			return null;
+		}
+
+		if (rootView.viewName.startsWith("module:")) {
+			return rootView.viewName.slice("module:".length) + ".js";
+		}
+
+		let viewTypeExtension;
+
+		switch (rootView.type) {
+		case "JS":
+			viewTypeExtension = ".view.js";
+			break;
+		case "JSON":
+			viewTypeExtension = ".view.json";
+			break;
+		case "Template":
+			viewTypeExtension = ".view.tmpl";
+			break;
+		case "XML":
+			viewTypeExtension = ".view.xml";
+			break;
+		case "HTML":
+			viewTypeExtension = ".view.html";
+			break;
+		default:
+			log.warn(`Unable to analyze sap.ui5/rootView: Unknown type '${rootView.type}'`);
+			return null;
+		}
+
+		return fromUI5LegacyName(rootView.viewName, viewTypeExtension);
+	}
+
 	/**
 	 * Evaluates a manifest after it has been read and parsed
 	 * and adds any newly found dependencies to the given info object.
@@ -88,30 +135,21 @@ class ComponentAnalyzer {
 		}
 
 		if ( ui5.rootView ) {
-			let rootView;
-			if ( typeof ui5.rootView === "string" ) {
-				rootView = {
-					viewName: ui5.rootView,
-					type: "XML"
-				};
-			} else {
-				rootView = ui5.rootView;
+			const module = this._getRootViewModule(ui5.rootView);
+			if (module) {
+				log.verbose("adding root view dependency ", module);
+				info.addDependency( module );
 			}
-			const module = ModuleName.fromUI5LegacyName(
-				rootView.viewName,
-				".view." + rootView.type.toLowerCase() );
-			log.verbose("adding root view dependency ", module);
-			info.addDependency( module );
 		}
 
 		each( ui5.dependencies && ui5.dependencies.libs, (options, lib) => {
-			const module = ModuleName.fromUI5LegacyName(lib, "/library.js");
+			const module = fromUI5LegacyName(lib, "/library.js");
 			log.verbose("adding library dependency ", module, options.lazy || false);
 			info.addDependency( module, options.lazy ); // lazy -> conditional dependency
 		});
 
 		each( ui5.dependencies && ui5.dependencies.components, (options, component) => {
-			const module = ModuleName.fromUI5LegacyName(component, "/Component.js");
+			const module = fromUI5LegacyName(component, "/Component.js");
 			log.verbose("adding component dependency ", module, options.lazy || false);
 			info.addDependency( module, options.lazy ); // lazy -> conditional dependency
 		});
@@ -163,7 +201,7 @@ class ComponentAnalyzer {
 				log.warn(`Neither a type nor a dataSource has been defined for model "${model}".`);
 				return;
 			}
-			const module = ModuleName.fromUI5LegacyName( modelType );
+			const module = fromUI5LegacyName( modelType );
 			log.verbose("derived model implementation dependency ", module);
 			info.addDependency(module);
 		});
@@ -175,7 +213,7 @@ class ComponentAnalyzer {
 			// See sap/ui/core/UIComponent#init
 			if (routing.routes) {
 				const routerClassName = routingConfig.routerClass || "sap.ui.core.routing.Router";
-				const routerClassModule = ModuleName.fromUI5LegacyName(routerClassName);
+				const routerClassModule = fromUI5LegacyName(routerClassName);
 				log.verbose(`adding router dependency '${routerClassModule}'`);
 				info.addDependency(routerClassModule);
 			} else if (routing.targets) {
@@ -194,7 +232,7 @@ class ComponentAnalyzer {
 					if (target && target.viewName) {
 						// merge target config with default config
 						const config = Object.assign({}, routing.config, target);
-						const module = ModuleName.fromUI5LegacyName(
+						const module = fromUI5LegacyName(
 							(config.viewPath ? config.viewPath + "." : "") +
 							config.viewName, ".view." + config.viewType.toLowerCase() );
 						log.verbose("converting routing target '%s' to view dependency '%s'", targetName, module);
@@ -209,4 +247,4 @@ class ComponentAnalyzer {
 	}
 }
 
-module.exports = ComponentAnalyzer;
+export default ComponentAnalyzer;

package/lib/lbt/analyzer/FioriElementsAnalyzer.js

@@ -56,13 +56,13 @@
  * This class can handle multiple concurrent analysis calls, it has no instance state other than the pool
  * (which is readonly).
  */
-"use strict";
 
-const ModuleName = require("../utils/ModuleName");
-const SapUiDefine = require("../calls/SapUiDefine");
-const {parseJS, Syntax} = require("../utils/parseUtils");
-const {getValue, isMethodCall, isString} = require("../utils/ASTUtils");
-const log = require("@ui5/logger").getLogger("lbt:analyzer:FioriElementAnalyzer");
+import {fromUI5LegacyName} from "../utils/ModuleName.js";
+import SapUiDefine from "../calls/SapUiDefine.js";
+import {parseJS, Syntax} from "../utils/parseUtils.js";
+import {getValue, isMethodCall, getStringValue} from "../utils/ASTUtils.js";
+import logger from "@ui5/logger";
+const log = logger.getLogger("lbt:analyzer:FioriElementAnalyzer");
 
 // ---------------------------------------------------------------------------------------------------------
 
@@ -129,7 +129,7 @@ class FioriElementsAnalyzer {
 				}
 				each(activityCfg, (actionCfg) => {
 					if ( actionCfg.template ) {
-						const module = ModuleName.fromUI5LegacyName( "sap.fe.templates." +
+						const module = fromUI5LegacyName( "sap.fe.templates." +
 										actionCfg.template + ".Component" );
 						log.verbose("template app: add dependency to template component %s", module);
 						info.addDependency(module);
@@ -151,7 +151,7 @@ class FioriElementsAnalyzer {
 		const templateName = (pageConfig.component && pageConfig.component.settings &&
 								pageConfig.component.settings.templateName) || defaultTemplateName;
 		if ( templateName ) {
-			const templateModuleName = ModuleName.fromUI5LegacyName( templateName, ".view.xml" );
+			const templateModuleName = fromUI5LegacyName( templateName, ".view.xml" );
 			log.verbose("template app: add dependency to template view %s", templateModuleName);
 			appInfo.addDependency(templateModuleName);
 		}
@@ -165,25 +165,36 @@ class FioriElementsAnalyzer {
 			const TA = defineCall.findImportName("sap/fe/core/TemplateAssembler.js");
 			// console.log("local name for TemplateAssembler: %s", TA);
 			if ( TA && defineCall.factory ) {
-				defineCall.factory.body.body.forEach( (stmt) => {
-					if ( stmt.type === Syntax.ReturnStatement &&
-							isMethodCall(stmt.argument, [TA, "getTemplateComponent"]) &&
-							stmt.argument.arguments.length > 2 &&
-							stmt.argument.arguments[2].type === "ObjectExpression" ) {
-						templateName = this._analyzeTemplateClassDefinition(stmt.argument.arguments[2]) || templateName;
+				if (defineCall.factory.type === Syntax.ArrowFunctionExpression &&
+					defineCall.factory.expression === true) {
+					if ( this._isTemplateClassDefinition(TA, defineCall.factory.body) ) {
+						templateName =
+							this._analyzeTemplateClassDefinition(defineCall.factory.body.arguments[2]) || templateName;
 					}
-				});
+				} else {
+					defineCall.factory.body.body.forEach( (stmt) => {
+						if ( stmt.type === Syntax.ReturnStatement &&
+							this._isTemplateClassDefinition(TA, stmt.argument)
+						) {
+							templateName =
+								this._analyzeTemplateClassDefinition(stmt.argument.arguments[2]) || templateName;
+						}
+					});
+				}
 			}
 		}
 		return templateName;
 	}
 
+	_isTemplateClassDefinition(TA, node) {
+		return isMethodCall(node, [TA, "getTemplateComponent"]) &&
+			node.arguments.length > 2 &&
+			node.arguments[2].type === "ObjectExpression";
+	}
+
 	_analyzeTemplateClassDefinition(clazz) {
-		const defaultValue = getValue(clazz, ["metadata", "properties", "templateName", "defaultValue"]);
-		if ( isString(defaultValue) ) {
-			return defaultValue.value;
-		}
+		return getStringValue(getValue(clazz, ["metadata", "properties", "templateName", "defaultValue"]));
 	}
 }
 
-module.exports = FioriElementsAnalyzer;
+export default FioriElementsAnalyzer;