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

package/lib/tasks/jsdoc/generateJsdoc.js

@@ -1,13 +1,20 @@
-const log = require("@ui5/logger").getLogger("builder:tasks:jsdoc:generateJsdoc");
-const path = require("path");
-const makeDir = require("make-dir");
-const os = require("os");
-const fs = require("graceful-fs");
-const {promisify} = require("util");
+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 rimraf = promisify(require("rimraf"));
-const jsdocGenerator = require("../../processors/jsdoc/jsdocGenerator");
-const {resourceFactory} = require("@ui5/fs");
+const rimraf = promisify(_rimraf);
+import jsdocGenerator from "../../processors/jsdoc/jsdocGenerator.js";
+import {createAdapter} from "@ui5/fs/resourceFactory";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/jsdoc/generateJsdoc
+ */
 
 /**
  *
@@ -23,30 +30,33 @@ const {resourceFactory} = require("@ui5/fs");
  * Task to execute a JSDoc build for UI5 projects
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateJsdoc
+ * @function default
+ * @static
+ *
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
- * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
- * @param {GenerateJsdocOptions} parameters.options Options
- * @param {module:@ui5/project.build.helpers.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @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
  */
-const generateJsdoc = async function({
+export default async function generateJsdoc({
 	taskUtil,
 	buildContext,
 	workspace,
 	dependencies,
 	options = {}
 }) {
-	const {projectName, namespace, version, pattern} = /** @type {GenerateJsdocOptions} */ (options);
+	const {projectName, namespace, version, pattern} =
+	/** @type {module:@ui5/builder/tasks/jsdoc/generateJsdoc~GenerateJsdocOptions} */ (options);
 
 	if (!projectName || !namespace || !version || !pattern) {
 		throw new Error("[generateJsdoc]: One or more mandatory options not provided");
 	}
 
 	const {sourcePath: resourcePath, targetPath, tmpPath, cleanup} =
-		await generateJsdoc._createTmpDirs(projectName);
+		await utils.createTmpDirs(projectName);
 
 	// TODO 3.0: remove buildContext
 	const _taskUtil = taskUtil || buildContext;
@@ -55,12 +65,12 @@ const generateJsdoc = async function({
 	}
 
 	const [writtenResourcesCount] = await Promise.all([
-		generateJsdoc._writeResourcesToDir({
+		utils.writeResourcesToDir({
 			workspace,
 			pattern,
 			targetPath: resourcePath
 		}),
-		generateJsdoc._writeDependencyApisToDir({
+		utils.writeDependencyApisToDir({
 			dependencies,
 			targetPath: path.join(tmpPath, "dependency-apis")
 		})
@@ -87,110 +97,112 @@ const generateJsdoc = async function({
 	await Promise.all(createdResources.map((resource) => {
 		return workspace.write(resource);
 	}));
-};
-
-/**
- * Create temporary directories for JSDoc generation processor
- *
- * @private
- * @param {string} projectName Project name used for naming the temporary working directory
- * @returns {Promise<object>} Promise resolving with sourcePath, targetPath and tmpPath strings
- */
-async function createTmpDirs(projectName) {
-	const tmpDirPath = await generateJsdoc._createTmpDir(projectName);
-
-	const sourcePath = path.join(tmpDirPath, "src"); // dir will be created by writing project resources below
-	await makeDir(sourcePath, {fs});
-	const targetPath = path.join(tmpDirPath, "target"); // dir will be created by jsdoc itself
-	await makeDir(targetPath, {fs});
-
-	const tmpPath = path.join(tmpDirPath, "tmp"); // dir needs to be created by us
-	await makeDir(tmpPath, {fs});
-
-	return {
-		sourcePath,
-		targetPath,
-		tmpPath,
-		cleanup: async () => {
-			return rimraf(tmpDirPath);
-		}
-	};
-}
-
-/**
- * Create a temporary directory on the host system
- *
- * @private
- * @param {string} projectName Project name used for naming the temporary directory
- * @returns {Promise<string>} Promise resolving with path of the temporary directory
- */
-async function createTmpDir(projectName) {
-	const sanitizedProjectName = projectName.replace(/[^A-Za-z0-9]/g, "");
-
-	const tmpRootPath = path.join(os.tmpdir(), "ui5-tooling");
-	await makeDir(tmpRootPath, {fs});
-
-	// Appending minus sign also because node docs advise to "avoid trailing X characters in prefix"
-	return mkdtemp(path.join(tmpRootPath, `jsdoc-${sanitizedProjectName}-`));
 }
 
-/**
- * Write resources from workspace matching the given pattern to the given fs destination
- *
- * @private
- * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
- * @param {string} parameters.pattern Pattern to match resources in workspace against
- * @param {string} parameters.targetPath Path to write the resources to
- * @returns {Promise<number>} Promise resolving with number of resources written to given directory
- */
-async function writeResourcesToDir({workspace, pattern, targetPath}) {
-	const fsTarget = resourceFactory.createAdapter({
-		fsBasePath: targetPath,
-		virBasePath: "/resources/"
-	});
-
-	let allResources;
-	if (workspace.byGlobSource) { // API only available on duplex collections
-		allResources = await workspace.byGlobSource(pattern);
-	} else {
-		allResources = await workspace.byGlob(pattern);
-	}
-
-	// write all resources to the tmp folder
-	await Promise.all(allResources.map((resource) => fsTarget.write(resource)));
-	return allResources.length;
-}
-
-/**
- * Write api.json files of dependencies to given target path in a flat structure
- *
- * @private
- * @param {object} parameters Parameters
- * @param {module:@ui5/fs.AbstractReader} parameters.dependencies Reader or Collection to read dependency files
- * @param {string} parameters.targetPath Path to write the resources to
- * @returns {Promise<number>} Promise resolving with number of resources written to given directory
- */
-async function writeDependencyApisToDir({dependencies, targetPath}) {
-	const depApis = await dependencies.byGlob("/test-resources/**/designtime/api.json");
+const utils = {
+	/**
+	 * Create temporary directories for JSDoc generation processor
+	 *
+	 * @private
+	 * @param {string} projectName Project name used for naming the temporary working directory
+	 * @returns {Promise<object>} Promise resolving with sourcePath, targetPath and tmpPath strings
+	 */
+	createTmpDirs: async function(projectName) {
+		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});
+		const targetPath = path.join(tmpDirPath, "target"); // dir will be created by jsdoc itself
+		await makeDir(targetPath, {fs});
+
+		const tmpPath = path.join(tmpDirPath, "tmp"); // dir needs to be created by us
+		await makeDir(tmpPath, {fs});
+
+		return {
+			sourcePath,
+			targetPath,
+			tmpPath,
+			cleanup: async () => {
+				return rimraf(tmpDirPath);
+			}
+		};
+	},
+
+	/**
+	 * Create a temporary directory on the host system
+	 *
+	 * @private
+	 * @param {string} projectName Project name used for naming the temporary directory
+	 * @returns {Promise<string>} Promise resolving with path of the temporary directory
+	 */
+	createTmpDir: async function(projectName) {
+		const sanitizedProjectName = projectName.replace(/[^A-Za-z0-9]/g, "");
+
+		const tmpRootPath = path.join(os.tmpdir(), "ui5-tooling");
+		await makeDir(tmpRootPath, {fs});
+
+		// Appending minus sign also because node docs advise to "avoid trailing X characters in prefix"
+		return mkdtemp(path.join(tmpRootPath, `jsdoc-${sanitizedProjectName}-`));
+	},
+
+	/**
+	 * Write resources from workspace matching the given pattern to the given fs destination
+	 *
+	 * @private
+	 * @param {object} parameters Parameters
+	 * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
+	 * @param {string} parameters.pattern Pattern to match resources in workspace against
+	 * @param {string} parameters.targetPath Path to write the resources to
+	 * @returns {Promise<number>} Promise resolving with number of resources written to given directory
+	 */
+	writeResourcesToDir: async function({workspace, pattern, targetPath}) {
+		const fsTarget = createAdapter({
+			fsBasePath: targetPath,
+			virBasePath: "/resources/"
+		});
+
+		let allResources;
+		if (workspace.byGlobSource) { // API only available on duplex collections
+			allResources = await workspace.byGlobSource(pattern);
+		} else {
+			allResources = await workspace.byGlob(pattern);
+		}
 
-	// Clone resources before changing their path
-	const apis = await Promise.all(depApis.map((resource) => resource.clone()));
+		// write all resources to the tmp folder
+		await Promise.all(allResources.map((resource) => fsTarget.write(resource)));
+		return allResources.length;
+	},
+
+	/**
+	 * Write api.json files of dependencies to given target path in a flat structure
+	 *
+	 * @private
+	 * @param {object} parameters Parameters
+	 * @param {@ui5/fs/AbstractReader} parameters.dependencies Reader or Collection to read dependency files
+	 * @param {string} parameters.targetPath Path to write the resources to
+	 * @returns {Promise<number>} Promise resolving with number of resources written to given directory
+	 */
+	writeDependencyApisToDir: async function({dependencies, targetPath}) {
+		const depApis = await dependencies.byGlob("/test-resources/**/designtime/api.json");
+
+		// Clone resources before changing their path
+		const apis = await Promise.all(depApis.map((resource) => resource.clone()));
+
+		for (let i = 0; i < apis.length; i++) {
+			apis[i].setPath(`/api-${i}.json`);
+		}
 
-	for (let i = 0; i < apis.length; i++) {
-		apis[i].setPath(`/api-${i}.json`);
+		const fsTarget = createAdapter({
+			fsBasePath: targetPath,
+			virBasePath: "/"
+		});
+		await Promise.all(apis.map((resource) => fsTarget.write(resource)));
+		return apis.length;
 	}
+};
 
-	const fsTarget = resourceFactory.createAdapter({
-		fsBasePath: targetPath,
-		virBasePath: "/"
-	});
-	await Promise.all(apis.map((resource) => fsTarget.write(resource)));
-	return apis.length;
+// Export utils for testing only
+/* istanbul ignore else */
+if (process.env.NODE_ENV === "test") {
+	generateJsdoc._utils = utils;
 }
-
-module.exports = generateJsdoc;
-module.exports._createTmpDirs = createTmpDirs;
-module.exports._createTmpDir = createTmpDir;
-module.exports._writeResourcesToDir = writeResourcesToDir;
-module.exports._writeDependencyApisToDir = writeDependencyApisToDir;

package/lib/tasks/minify.js

@@ -1,20 +1,27 @@
-const minifier = require("../processors/minifier");
+import minifier from "../processors/minifier.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/minify
+ */
 
 /**
  * Task to minify resources.
  *
  * @public
- * @alias module:@ui5/builder.tasks.minify
+ * @function default
+ * @static
+ *
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
- * @param {module:@ui5/project.build.helpers.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} parameters.options Options
  * @param {string} parameters.options.pattern Pattern to locate the files to be processed
  * @param {boolean} [parameters.options.omitSourceMapResources=false] Whether source map resources shall
  * 		be tagged as "OmitFromBuildResult" and no sourceMappingURL shall be added to the minified resource
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, taskUtil, options: {pattern, omitSourceMapResources = false}}) {
+export default async function({workspace, taskUtil, options: {pattern, omitSourceMapResources = false}}) {
 	const resources = await workspace.byGlob(pattern);
 	const processedResources = await minifier({
 		resources,
@@ -38,4 +45,4 @@ module.exports = async function({workspace, taskUtil, options: {pattern, omitSou
 			workspace.write(sourceMapResource)
 		]);
 	}));
-};
+}

package/lib/tasks/replaceBuildtime.js

@@ -1,4 +1,4 @@
-const stringReplacer = require("../processors/stringReplacer");
+import stringReplacer from "../processors/stringReplacer.js";
 
 function pad(v) {
 	return String(v).padStart(2, "0");
@@ -14,18 +14,25 @@ function getTimestamp() {
 	return year + month + day + "-" + hours + minutes;
 }
 
+/**
+ * @public
+ * @module @ui5/builder/tasks/replaceBuildtime
+ */
+
 /**
  * Task to replace the buildtime <code>${buildtime}</code>.
  *
  * @public
- * @alias module:@ui5/builder.tasks.replaceBuildtime
+ * @function default
+ * @static
+ *
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.pattern Pattern to locate the files to be processed
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, options: {pattern}}) {
+export default function({workspace, options: {pattern}}) {
 	const timestamp = getTimestamp();
 
 	return workspace.byGlob(pattern)
@@ -43,4 +50,4 @@ module.exports = function({workspace, options: {pattern}}) {
 				return workspace.write(resource);
 			}));
 		});
-};
+}

package/lib/tasks/replaceCopyright.js

@@ -1,4 +1,9 @@
-const stringReplacer = require("../processors/stringReplacer");
+import stringReplacer from "../processors/stringReplacer.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/replaceCopyright
+ */
 
 /**
  * Task to to replace the copyright.
@@ -14,15 +19,17 @@ const stringReplacer = require("../processors/stringReplacer");
  * If no copyright string is given, no replacement is being done.
  *
  * @public
- * @alias module:@ui5/builder.tasks.replaceCopyright
+ * @function default
+ * @static
+ *
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.copyright Replacement copyright
  * @param {string} parameters.options.pattern Pattern to locate the files to be processed
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, options: {copyright, pattern}}) {
+export default function({workspace, options: {copyright, pattern}}) {
 	if (!copyright) {
 		return Promise.resolve();
 	}
@@ -45,4 +52,4 @@ module.exports = function({workspace, options: {copyright, pattern}}) {
 				return workspace.write(resource);
 			}));
 		});
-};
+}

package/lib/tasks/replaceVersion.js

@@ -1,18 +1,25 @@
-const stringReplacer = require("../processors/stringReplacer");
+import stringReplacer from "../processors/stringReplacer.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/replaceVersion
+ */
 
 /**
  * Task to replace the version <code>${version}</code>.
  *
  * @public
- * @alias module:@ui5/builder.tasks.replaceVersion
+ * @function default
+ * @static
+ *
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.pattern Pattern to locate the files to be processed
  * @param {string} parameters.options.version Replacement version
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, options: {pattern, version}}) {
+export default function({workspace, options: {pattern, version}}) {
 	return workspace.byGlob(pattern)
 		.then((allResources) => {
 			return stringReplacer({
@@ -28,4 +35,4 @@ module.exports = function({workspace, options: {pattern, version}}) {
 				return workspace.write(resource);
 			}));
 		});
-};
+}

package/lib/tasks/taskRepository.js

@@ -1,32 +1,31 @@
 const taskInfos = {
-	replaceCopyright: {path: "./replaceCopyright"},
-	replaceVersion: {path: "./replaceVersion"},
-	replaceBuildtime: {path: "./replaceBuildtime"},
-	escapeNonAsciiCharacters: {path: "./escapeNonAsciiCharacters"},
-	executeJsdocSdkTransformation: {path: "./jsdoc/executeJsdocSdkTransformation"},
-	generateApiIndex: {path: "./jsdoc/generateApiIndex"},
-	generateJsdoc: {path: "./jsdoc/generateJsdoc"},
-	minify: {path: "./minify"},
-	buildThemes: {path: "./buildThemes"},
-	transformBootstrapHtml: {path: "./transformBootstrapHtml"},
-	generateLibraryManifest: {path: "./generateLibraryManifest"},
-	generateVersionInfo: {path: "./generateVersionInfo"},
-	generateManifestBundle: {path: "./bundlers/generateManifestBundle"},
-	generateFlexChangesBundle: {path: "./bundlers/generateFlexChangesBundle"},
-	generateComponentPreload: {path: "./bundlers/generateComponentPreload"},
-	generateResourcesJson: {path: "./generateResourcesJson"},
-	generateThemeDesignerResources: {path: "./generateThemeDesignerResources"},
-	generateStandaloneAppBundle: {path: "./bundlers/generateStandaloneAppBundle"},
-	generateBundle: {path: "./bundlers/generateBundle"},
-	generateLibraryPreload: {path: "./bundlers/generateLibraryPreload"},
-	generateCachebusterInfo: {path: "./generateCachebusterInfo"}
+	replaceCopyright: {path: "./replaceCopyright.js"},
+	replaceVersion: {path: "./replaceVersion.js"},
+	replaceBuildtime: {path: "./replaceBuildtime.js"},
+	escapeNonAsciiCharacters: {path: "./escapeNonAsciiCharacters.js"},
+	executeJsdocSdkTransformation: {path: "./jsdoc/executeJsdocSdkTransformation.js"},
+	generateApiIndex: {path: "./jsdoc/generateApiIndex.js"},
+	generateJsdoc: {path: "./jsdoc/generateJsdoc.js"},
+	minify: {path: "./minify.js"},
+	buildThemes: {path: "./buildThemes.js"},
+	transformBootstrapHtml: {path: "./transformBootstrapHtml.js"},
+	generateLibraryManifest: {path: "./generateLibraryManifest.js"},
+	generateVersionInfo: {path: "./generateVersionInfo.js"},
+	generateFlexChangesBundle: {path: "./bundlers/generateFlexChangesBundle.js"},
+	generateComponentPreload: {path: "./bundlers/generateComponentPreload.js"},
+	generateResourcesJson: {path: "./generateResourcesJson.js"},
+	generateThemeDesignerResources: {path: "./generateThemeDesignerResources.js"},
+	generateStandaloneAppBundle: {path: "./bundlers/generateStandaloneAppBundle.js"},
+	generateBundle: {path: "./bundlers/generateBundle.js"},
+	generateLibraryPreload: {path: "./bundlers/generateLibraryPreload.js"},
+	generateCachebusterInfo: {path: "./generateCachebusterInfo.js"}
 };
 
-function getTask(taskName) {
+export async function getTask(taskName) {
 	const taskInfo = taskInfos[taskName];
 
 	if (!taskInfo) {
-		if (["createDebugFiles", "uglify"].includes(taskName)) {
+		if (["createDebugFiles", "uglify", "generateManifestBundle"].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/`);
@@ -34,7 +33,7 @@ function getTask(taskName) {
 		throw new Error(`taskRepository: Unknown Task ${taskName}`);
 	}
 	try {
-		const task = require(taskInfo.path);
+		const {default: task} = await import(taskInfo.path);
 		return {
 			task
 		};
@@ -43,11 +42,6 @@ function getTask(taskName) {
 	}
 }
 
-function getAllTaskNames() {
+export function getAllTaskNames() {
 	return Object.keys(taskInfos);
 }
-
-module.exports = {
-	getTask,
-	getAllTaskNames
-};

package/lib/tasks/transformBootstrapHtml.js

@@ -1,5 +1,6 @@
-const log = require("@ui5/logger").getLogger("builder:tasks:transformBootstrapHtml");
-const bootstrapHtmlTransformer = require("../processors/bootstrapHtmlTransformer");
+import logger from "@ui5/logger";
+const log = logger.getLogger("builder:tasks:transformBootstrapHtml");
+import bootstrapHtmlTransformer from "../processors/bootstrapHtmlTransformer.js";
 
 /* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
 /**
@@ -7,13 +8,13 @@ const bootstrapHtmlTransformer = require("../processors/bootstrapHtmlTransformer
  *
  * @module builder/tasks/transformBootstrapHtml
  * @param {object} parameters Parameters
- * @param {module:@ui5/fs.DuplexCollection} parameters.workspace DuplexCollection to read and write files
+ * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @param {string} [parameters.options.namespace] Project namespace
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, options}) {
+export default async function({workspace, options}) {
 	const {projectName} = options;
 	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
 	const namespace = options.projectNamespace || options.namespace;
@@ -36,4 +37,4 @@ module.exports = async function({workspace, options}) {
 		}
 	});
 	await Promise.all(processedResources.map((resource) => workspace.write(resource)));
-};
+}