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

package/lib/tasks/escapeNonAsciiCharacters.js

@@ -1,18 +1,25 @@
-const nonAsciiEscaper = require("../processors/nonAsciiEscaper");
+import nonAsciiEscaper from "../processors/nonAsciiEscaper.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/escapeNonAsciiCharacters
+ */
 
 /**
  * Task to escape non ascii characters in properties files resources.
  *
  * @public
- * @alias module:@ui5/builder.tasks.escapeNonAsciiCharacters
+ * @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 Glob pattern to locate the files to be processed
  * @param {string} parameters.options.encoding source file encoding either "UTF-8" or "ISO-8859-1"
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, options: {pattern, encoding}}) {
+export default async function({workspace, options: {pattern, encoding}}) {
 	if (!encoding) {
 		throw new Error("[escapeNonAsciiCharacters] Mandatory option 'encoding' not provided");
 	}
@@ -27,4 +34,4 @@ module.exports = async function({workspace, options: {pattern, encoding}}) {
 	});
 
 	await Promise.all(processedResources.map((resource) => workspace.write(resource)));
-};
+}

package/lib/tasks/generateCachebusterInfo.js

@@ -1,6 +1,12 @@
-const crypto = require("crypto");
-const resourceFactory = require("@ui5/fs").resourceFactory;
-const log = require("@ui5/logger").getLogger("builder:tasks:generateCachebusterInfo");
+import crypto from "node:crypto";
+import {createResource} from "@ui5/fs/resourceFactory";
+import logger from "@ui5/logger";
+const log = logger.getLogger("builder:tasks:generateCachebusterInfo");
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/generateCachebusterInfo
+ */
 
 async function signByTime(resource) {
 	return resource.getStatInfo().mtime.getTime();
@@ -33,15 +39,17 @@ function getSigner(type) {
  * Task to generate the application cachebuster info file.
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateCachebusterInfo
+ * @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.projectNamespace Namespace of the application
  * @param {string} [parameters.options.signatureType='time'] Type of signature to be used ('time' or 'hash')
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, options}) {
+export default function({workspace, options}) {
 	const {signatureType} = options;
 	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
 	const namespace = options.projectNamespace || options.namespace;
@@ -49,7 +57,7 @@ module.exports = function({workspace, options}) {
 	const basePath = `/resources/${namespace}/`;
 	return workspace.byGlob(`/resources/${namespace}/**/*`)
 		.then(async (resources) => {
-			const cachebusterInfo = {};
+			const cachebusterInfo = Object.create(null);
 			const signer = getSigner(signatureType);
 
 			await Promise.all(resources.map(async (resource) => {
@@ -63,10 +71,10 @@ module.exports = function({workspace, options}) {
 				resourcePath = resourcePath.replace(basePath, "");
 				cachebusterInfo[resourcePath] = await signer(resource);
 			}));
-			const cachebusterInfoResource = resourceFactory.createResource({
+			const cachebusterInfoResource = createResource({
 				path: `/resources/${namespace}/sap-ui-cachebuster-info.json`,
 				string: JSON.stringify(cachebusterInfo, null, 2)
 			});
 			return workspace.write(cachebusterInfoResource);
 		});
-};
+}

package/lib/tasks/generateLibraryManifest.js

@@ -1,22 +1,28 @@
-"use strict";
 
-const log = require("@ui5/logger").getLogger("builder:tasks:generateLibraryManifest");
-const manifestCreator = require("../processors/manifestCreator");
+import logger from "@ui5/logger";
+const log = logger.getLogger("builder:tasks:generateLibraryManifest");
+import manifestCreator from "../processors/manifestCreator.js";
 
+/**
+ * @public
+ * @module @ui5/builder/tasks/generateLibraryManifest
+ */
 
 /**
  * Task for creating a library manifest.json from its .library file.
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateLibraryManifest
+ * @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.projectName Project name
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = function({workspace, taskUtil, options: {projectName}}) {
+export default function({workspace, taskUtil, options: {projectName}}) {
 	// Note:
 	// *.library files are needed to identify libraries
 	// *.json files are needed to avoid overwriting them
@@ -64,4 +70,4 @@ module.exports = function({workspace, taskUtil, options: {projectName}}) {
 			}));
 		});
 	});
-};
+}

package/lib/tasks/generateResourcesJson.js

@@ -1,6 +1,5 @@
-"use strict";
 
-const resourceListCreator = require("../processors/resourceListCreator");
+import resourceListCreator from "../processors/resourceListCreator.js";
 
 const DEFAULT_EXCLUDES = [
 	/*
@@ -38,6 +37,11 @@ function getCreatorOptions(projectName) {
 	return creatorOptions;
 }
 
+/**
+ * @public
+ * @module @ui5/builder/tasks/generateResourcesJson
+ */
+
 /**
  * Task for creating a resources.json file, describing all productive build resources.
  *
@@ -47,7 +51,7 @@ function getCreatorOptions(projectName) {
  * </p>
  *
  * <p>
- * Not supported in combination with task {@link module:@ui5/builder.tasks.generateStandaloneAppBundle}.
+ * Not supported in combination with task {@link @ui5/builder/tasks/bundlers/generateStandaloneAppBundle}.
  * Therefore it is also not supported in combination with self-contained build.
  * </p>
  *
@@ -93,16 +97,18 @@ function getCreatorOptions(projectName) {
  * };
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateResourcesJson
+ * @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 {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 {@ui5/project/build/helpers/TaskUtil|object} [parameters.taskUtil] TaskUtil
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, dependencies, taskUtil, options: {projectName}}) {
+export default async function({workspace, dependencies, taskUtil, options: {projectName}}) {
 	let resources = await workspace.byGlob(["/resources/**/*"].concat(DEFAULT_EXCLUDES));
 	let dependencyResources =
 			await dependencies.byGlob("/resources/**/*.{js,json,xml,html,properties,library,js.map}");
@@ -125,4 +131,4 @@ module.exports = async function({workspace, dependencies, taskUtil, options: {pr
 	await Promise.all(
 		resourceLists.map((resourceList) => workspace.write(resourceList))
 	);
-};
+}

package/lib/tasks/generateThemeDesignerResources.js

@@ -1,7 +1,10 @@
-const posixPath = require("path").posix;
-const log = require("@ui5/logger").getLogger("builder:tasks:generateThemeDesignerResources");
-const libraryLessGenerator = require("../processors/libraryLessGenerator");
-const {ReaderCollectionPrioritized, Resource, fsInterface} = require("@ui5/fs");
+import posixPath from "node:path/posix";
+import logger from "@ui5/logger";
+const log = logger.getLogger("builder:tasks:generateThemeDesignerResources");
+import libraryLessGenerator from "../processors/libraryLessGenerator.js";
+import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
+import Resource from "@ui5/fs/Resource";
+import fsInterface from "@ui5/fs/fsInterface";
 
 /**
  * Returns a relative path from the given themeFolder to the root namespace.
@@ -187,15 +190,22 @@ async function generateCssVariablesLess({workspace, combo, namespace}) {
 	}
 }
 
+/**
+ * @public
+ * @module @ui5/builder/tasks/generateThemeDesignerResources
+ */
+
 /* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
 /**
  * Generates resources required for integration with the SAP Theme Designer.
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateThemeDesignerResources
+ * @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 {@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 {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @param {string} parameters.options.version Project version
@@ -204,7 +214,7 @@ async function generateCssVariablesLess({workspace, combo, namespace}) {
  * Omit for type <code>theme-library</code>
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({workspace, dependencies, options}) {
+export default async function({workspace, dependencies, options}) {
 	const {projectName, version} = options;
 	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
 	const namespace = options.projectNamespace || options.namespace;
@@ -279,4 +289,4 @@ module.exports = async function({workspace, dependencies, options}) {
 
 	// css_variables.less
 	await generateCssVariablesLess({workspace, combo, namespace});
-};
+}

package/lib/tasks/generateVersionInfo.js

@@ -1,21 +1,28 @@
-const versionInfoGenerator = require("../processors/versionInfoGenerator");
+import versionInfoGenerator from "../processors/versionInfoGenerator.js";
 
 const MANIFEST_JSON = "manifest.json";
 
+/**
+ * @public
+ * @module @ui5/builder/tasks/generateVersionInfo
+ */
+
 /**
  * Task to create sap-ui-version.json
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateVersionInfo
+ * @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 {@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 {object} parameters.options Options
  * @param {string} parameters.options.pattern Glob pattern for .library resources
  * @param {object} parameters.options.rootProject DuplexCollection to read and write files
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async ({workspace, dependencies, options: {rootProject, pattern}}) => {
+export default async ({workspace, dependencies, options: {rootProject, pattern}}) => {
 	const resources = await dependencies.byGlob(pattern);
 
 	const libraryInfosPromises = resources.map((dotLibResource) => {

package/lib/tasks/jsdoc/executeJsdocSdkTransformation.js

@@ -1,18 +1,26 @@
-const log = require("@ui5/logger").getLogger("builder:tasks:jsdoc:executeJsdocSdkTransformation");
-const ReaderCollectionPrioritized = require("@ui5/fs").ReaderCollectionPrioritized;
-const fsInterface = require("@ui5/fs").fsInterface;
-const sdkTransformer = require("../../processors/jsdoc/sdkTransformer");
+import logger from "@ui5/logger";
+const log = logger.getLogger("builder:tasks:jsdoc:executeJsdocSdkTransformation");
+import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
+import fsInterface from "@ui5/fs/fsInterface";
+import sdkTransformer from "../../processors/jsdoc/sdkTransformer.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/jsdoc/executeJsdocSdkTransformation
+ */
 
 /**
  * Task to transform the api.json file as created by the
- * [generateJsdoc]{@link module:@ui5/builder.tasks.generateJsdoc} task into a pre-processed api.json
+ * [generateJsdoc]{@link @ui5/builder/tasks/jsdoc/generateJsdoc} task into a pre-processed api.json
  * file suitable for the SDK.
  *
  * @public
- * @alias module:@ui5/builder.tasks.executeJsdocSdkTransformation
+ * @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 {@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 {object} parameters.options Options
  * @param {string|Array} parameters.options.dotLibraryPattern Pattern to locate the .library resource to be processed
  * @param {string} parameters.options.projectName Project name
@@ -73,4 +81,4 @@ const executeJsdocSdkTransformation = async function(
 	}));
 };
 
-module.exports = executeJsdocSdkTransformation;
+export default executeJsdocSdkTransformation;

package/lib/tasks/jsdoc/generateApiIndex.js

@@ -1,23 +1,29 @@
-const ui5Fs = require("@ui5/fs");
-const ReaderCollectionPrioritized = ui5Fs.ReaderCollectionPrioritized;
-const fsInterface = ui5Fs.fsInterface;
-const apiIndexGenerator = require("../../processors/jsdoc/apiIndexGenerator");
+import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
+import fsInterface from "@ui5/fs/fsInterface";
+import apiIndexGenerator from "../../processors/jsdoc/apiIndexGenerator.js";
+
+/**
+ * @public
+ * @module @ui5/builder/tasks/jsdoc/generateApiIndex
+ */
 
 /**
  * Compiles an api-index.json resource from all available api.json resources as created by the
- * [executeJsdocSdkTransformation]{@link module:@ui5/builder.tasks.executeJsdocSdkTransformation} task.
+ * [executeJsdocSdkTransformation]{@link @ui5/builder/tasks/jsdoc/executeJsdocSdkTransformation} task.
  * The resulting api-index.json resource is mainly to be used in the SDK.
  *
  * @public
- * @alias module:@ui5/builder.tasks.generateApiIndex
+ * @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 {@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 {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  */
-module.exports = async function({
+export default async function({
 	workspace,
 	dependencies,
 	options: {projectName}
@@ -47,4 +53,4 @@ module.exports = async function({
 	await Promise.all(createdResources.map((resource) => {
 		return workspace.write(resource);
 	}));
-};
+}