@ui5/builder 3.0.0-beta.4 → 3.0.0-beta.6

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 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-beta.4...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.6...HEAD).
+
+<a name="v3.0.0-beta.6"></a>
+## [v3.0.0-beta.6] - 2022-12-13
+
+<a name="v3.0.0-beta.5"></a>
+## [v3.0.0-beta.5] - 2022-12-12
+### Breaking Changes
+- **generateJsDoc:** Remove internal 'buildContext' parameter [`4ec80c8`](https://github.com/SAP/ui5-builder/commit/4ec80c874e177b658b1cd819431b6cb0660ded87)
+
+### Dependency Updates
+- Bump less-openui5 from 0.11.4 to 0.11.5 [`bf46354`](https://github.com/SAP/ui5-builder/commit/bf463541b7651db1dee167057eddc94181f5c1da)
+
 
 <a name="v3.0.0-beta.4"></a>
 ## [v3.0.0-beta.4] - 2022-12-01
@@ -816,6 +828,8 @@ 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.6]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.5...v3.0.0-beta.6
+[v3.0.0-beta.5]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.4...v3.0.0-beta.5
 [v3.0.0-beta.4]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.3...v3.0.0-beta.4
 [v3.0.0-beta.3]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.2...v3.0.0-beta.3
 [v3.0.0-beta.2]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.1...v3.0.0-beta.2

package/lib/lbt/analyzer/JSModuleAnalyzer.js

@@ -19,7 +19,7 @@ const log = logger.getLogger("lbt:analyzer:JSModuleAnalyzer");
 
 // ------------------------------------------------------------------------------------------------------------------
 
-const EnrichedVisitorKeys = (function() {
+export const EnrichedVisitorKeys = (function() {
 	function toBeDone() {
 		return null;
 	}
@@ -184,36 +184,23 @@ const EnrichedVisitorKeys = (function() {
 
 	// merge with 'official' visitor keys
 	Object.keys(VisitorKeys).forEach( (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.
-		if (type.startsWith("JSX")) {
-			return;
-		}
-
 		const visitorKeys = VisitorKeys[type];
 		const condKeys = TempKeys[type];
-		if ( condKeys === undefined ) {
-			// configuration missing in ConditionalKeys, maybe a new syntax ?
-			throw new Error(`unknown estree node type '${type}', new syntax?`);
-		} else if ( Array.isArray(condKeys) ) {
+		if ( Array.isArray(condKeys) ) {
 			// check configured keys against visitor keys
 			condKeys.forEach( (key) => {
-				if ( visitorKeys.indexOf(key) < 0 ) {
+				if ( !visitorKeys.includes(key) ) {
 					throw new Error(`configuration for type '${type}' contains unknown key '${key}'`);
 				}
 			});
 			TempKeys[type] = visitorKeys.map( (key) => ({
 				key: key,
-				conditional: condKeys.indexOf(key) >= 0
+				conditional: condKeys.includes(key)
 			}) );
-		} else {
+		} else if (condKeys === null) {
 			// this is a 'toBeDone' node type, keep null and complain at runtime when such a node occurs
+		} else {
+			// undefined => ignored node type (see JSModuleAnalyzer consistency test)
 		}
 	});
 
@@ -749,7 +736,7 @@ class JSModuleAnalyzer {
 				const value = getStringValue(item);
 				if ( value !== undefined ) {
 					// ignore special AMD dependencies (require, exports, module)
-					if ( SPECIAL_AMD_DEPENDENCIES.indexOf(value) >= 0 ) {
+					if ( SPECIAL_AMD_DEPENDENCIES.includes(value) ) {
 						return;
 					}
 					let requiredModule;

package/lib/lbt/utils/parseUtils.js

@@ -3,11 +3,19 @@ import {parse} from "espree";
 
 const hasOwn = Function.prototype.call.bind(Object.prototype.hasOwnProperty);
 
+/*
+ * NOTE: After updating the ecmaVersion:
+ * - Adopt JSModuleAnalyzer to handle new Syntax / VisitorKeys.
+ * - Adjust the JSModuleAnalyzer test "Check for consistency between VisitorKeys and EnrichedVisitorKeys"
+ *   (See comments in test for details)
+*/
+export const ecmaVersion = 2022;
+
 export function parseJS(code, userOptions = {}) {
 	// allowed options and their defaults
 	const options = {
 		comment: false,
-		ecmaVersion: 2022, // NOTE: Adopt JSModuleAnalyzer.js to allow new Syntax when upgrading to newer ECMA versions
+		ecmaVersion,
 		range: false,
 		sourceType: "script",
 	};

package/lib/tasks/jsdoc/generateJsdoc.js

@@ -1,12 +1,12 @@
 import logger from "@ui5/logger";
 const log = logger.getLogger("builder:tasks:jsdoc:generateJsdoc");
 import path from "node:path";
-import makeDir from "make-dir";
 import os from "node:os";
 import fs from "graceful-fs";
 import _rimraf from "rimraf";
 import {promisify} from "node:util";
 const mkdtemp = promisify(fs.mkdtemp);
+const mkdir = promisify(fs.mkdir);
 const rimraf = promisify(_rimraf);
 import jsdocGenerator from "../../processors/jsdoc/jsdocGenerator.js";
 import {createAdapter} from "@ui5/fs/resourceFactory";
@@ -38,12 +38,10 @@ import {createAdapter} from "@ui5/fs/resourceFactory";
  * @param {@ui5/fs/AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  * @param {module:@ui5/builder/tasks/jsdoc/generateJsdoc~GenerateJsdocOptions} parameters.options Options
  * @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
- * @param {object} [parameters.buildContext] Internal, deprecated parameter
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
 export default async function generateJsdoc({
 	taskUtil,
-	buildContext,
 	workspace,
 	dependencies,
 	options = {}
@@ -58,11 +56,7 @@ export default async function generateJsdoc({
 	const {sourcePath: resourcePath, targetPath, tmpPath, cleanup} =
 		await utils.createTmpDirs(projectName);
 
-	// TODO 3.0: remove buildContext
-	const _taskUtil = taskUtil || buildContext;
-	if (_taskUtil) {
-		_taskUtil.registerCleanupTask(cleanup);
-	}
+	taskUtil?.registerCleanupTask(cleanup);
 
 	const [writtenResourcesCount] = await Promise.all([
 		utils.writeResourcesToDir({
@@ -111,12 +105,12 @@ const utils = {
 		const tmpDirPath = await utils.createTmpDir(projectName);
 
 		const sourcePath = path.join(tmpDirPath, "src"); // dir will be created by writing project resources below
-		await makeDir(sourcePath, {fs});
+		await mkdir(sourcePath, {recursive: true});
 		const targetPath = path.join(tmpDirPath, "target"); // dir will be created by jsdoc itself
-		await makeDir(targetPath, {fs});
+		await mkdir(targetPath, {recursive: true});
 
 		const tmpPath = path.join(tmpDirPath, "tmp"); // dir needs to be created by us
-		await makeDir(tmpPath, {fs});
+		await mkdir(tmpPath, {recursive: true});
 
 		return {
 			sourcePath,
@@ -139,7 +133,7 @@ const utils = {
 		const sanitizedProjectName = projectName.replace(/[^A-Za-z0-9]/g, "");
 
 		const tmpRootPath = path.join(os.tmpdir(), "ui5-tooling");
-		await makeDir(tmpRootPath, {fs});
+		await mkdir(tmpRootPath, {recursive: true});
 
 		// Appending minus sign also because node docs advise to "avoid trailing X characters in prefix"
 		return mkdtemp(path.join(tmpRootPath, `jsdoc-${sanitizedProjectName}-`));

package/lib/tasks/taskRepository.js

@@ -1,3 +1,18 @@
+import {createRequire} from "node:module";
+
+/**
+ * Repository providing access to all UI5 Builder tasks and various metadata required by the build process.
+ * This module is designed to be imported by @ui5/project or to be passed as a private parameter
+ * to the <code>build</code> function of a [@ui5/project/graph/ProjectGraph]{@link @ui5/project/graph/ProjectGraph}.
+ *
+ * For other use cases, it is recommended to import the required tasks directly.
+ *
+ * Therefore, all API of this module is private.
+ *
+ * @private
+ * @module @ui5/builder/tasks/taskRepository
+ */
+
 const taskInfos = {
 	replaceCopyright: {path: "./replaceCopyright.js"},
 	replaceVersion: {path: "./replaceVersion.js"},
@@ -21,11 +36,29 @@ const taskInfos = {
 	generateCachebusterInfo: {path: "./generateCachebusterInfo.js"}
 };
 
+
+/**
+ * TaskInfo object returned by the getTask function
+ *
+ * @private
+ * @typedef {object} @ui5/builder/tasks/taskRepository~TaskInfo
+ * @property {Function} task Task function
+ */
+
+/**
+ * Returns the module for a given task name
+ *
+ * @private
+ * @static
+ * @param {string} taskName Name of the task to retrieve
+ * @throws {Error} In case the specified task does not exist
+ * @returns {Promise<@ui5/builder/tasks/taskRepository~TaskInfo>} Object containing the task module
+ */
 export async function getTask(taskName) {
 	const taskInfo = taskInfos[taskName];
 
 	if (!taskInfo) {
-		if (["createDebugFiles", "uglify", "generateManifestBundle"].includes(taskName)) {
+		if (getRemovedTaskNames().includes(taskName)) {
 			throw new Error(
 				`Standard task ${taskName} has been removed in UI5 Tooling 3.0. ` +
 				`Please see the migration guide at https://sap.github.io/ui5-tooling/updates/migrate-v3/`);
@@ -42,6 +75,54 @@ export async function getTask(taskName) {
 	}
 }
 
+/**
+ * Returns a list of the names of all available tasks
+ *
+ * @private
+ * @static
+ * @returns {string[]} Array containing the names of all available tasks
+ */
 export function getAllTaskNames() {
 	return Object.keys(taskInfos);
 }
+
+/**
+ * Returns a list of the names of all tasks that have been removed
+ * in this or previous versions of ui5-builder.
+ *
+ * @private
+ * @static
+ * @returns {string[]} Array containing the names of all removed tasks
+ */
+export function getRemovedTaskNames() {
+	return ["createDebugFiles", "uglify", "generateManifestBundle"];
+}
+
+// Using CommonsJS require as importing json files causes an ExperimentalWarning
+const require = createRequire(import.meta.url);
+function getVersion(pkg) {
+	return require(`${pkg}/package.json`).version;
+}
+
+/**
+ * Object containing the versions of the ui5-builder module and relevant dependencies
+ *
+ * @private
+ * @typedef {object} @ui5/builder/tasks/taskRepository~Versions
+ * @property {string} builderVersion Version of the ui5-builder module
+ * @property {string} fsVersion Version of the ui5-fs module in use
+ */
+
+/**
+ * Provides version information on all relevant modules, used by ui5-builder
+ *
+ * @private
+ * @static
+ * @returns {@ui5/builder/tasks/taskRepository~Versions} Object containing version information
+ */
+export async function getVersions() {
+	return {
+		builderVersion: getVersion("@ui5/builder"),
+		fsVersion: getVersion("@ui5/fs"),
+	};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.0.0-beta.4",
+	"version": "3.0.0-beta.6",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -127,13 +127,12 @@
 		"espree": "^9.4.1",
 		"graceful-fs": "^4.2.10",
 		"jsdoc": "^3.6.11",
-		"less-openui5": "^0.11.4",
-		"make-dir": "^3.1.0",
+		"less-openui5": "^0.11.5",
 		"pretty-data": "^0.40.0",
 		"replacestream": "^4.0.3",
 		"rimraf": "^3.0.2",
 		"semver": "^7.3.8",
-		"terser": "^5.16.0",
+		"terser": "^5.16.1",
 		"xml2js": "^0.4.23"
 	},
 	"devDependencies": {
@@ -146,15 +145,15 @@
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
 		"docdash": "^2.0.0",
-		"eslint": "^8.28.0",
+		"eslint": "^8.29.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^13.2.0",
 		"eslint-plugin-jsdoc": "^39.6.4",
-		"esmock": "^2.0.9",
+		"esmock": "^2.1.0",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.1.0",
 		"recursive-readdir": "^2.2.3",
-		"sinon": "^14.0.2",
+		"sinon": "^15.0.0",
 		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"
 	}