@ui5/builder 3.0.0-alpha.10 → 3.0.0-alpha.12

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,28 +1,28 @@
 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"},
+	generateManifestBundle: {path: "./bundlers/generateManifestBundle.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) {
@@ -34,7 +34,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 +43,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)));
-};
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.0.0-alpha.10",
+	"version": "3.0.0-alpha.12",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -16,7 +16,17 @@
 		"development",
 		"tool"
 	],
-	"main": "index.js",
+	"type": "module",
+	"exports": {
+		"./processors/*": "./lib/processors/*.js",
+		"./processors/jsdoc/lib/*": null,
+		"./tasks/*": "./lib/tasks/*.js",
+		"./tasks/taskRepository": null,
+		"./tasks/bundlers/utils/*": null,
+		"./package.json": "./package.json",
+		"./internal/taskRepository": "./lib/tasks/taskRepository.js",
+		"./internal/jsdoc/template/publish": "./lib/processors/jsdoc/lib/ui5/template/publish.cjs"
+	},
 	"engines": {
 		"node": ">= 16.13.2",
 		"npm": ">= 8"
@@ -29,9 +39,9 @@
 		"unit-verbose": "rimraf test/tmp && cross-env UI5_LOG_LVL=verbose ava --verbose --serial",
 		"unit-watch": "rimraf test/tmp && ava --watch",
 		"unit-nyan": "rimraf test/tmp && ava --tap | tnyan",
-		"unit-xunit": "rimraf test/tmp && ava --tap --timeout=1m | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
+		"unit-xunit": "rimraf test/tmp && ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\" --tap --timeout=1m | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
 		"unit-inspect": "cross-env UI5_LOG_LVL=verbose ava debug --break",
-		"coverage": "nyc npm run unit",
+		"coverage": "rimraf test/tmp && nyc ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\"",
 		"coverage-xunit": "nyc --reporter=text --reporter=text-summary --reporter=cobertura npm run unit-xunit",
 		"jsdoc": "npm run jsdoc-generate && open-cli jsdocs/index.html",
 		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
@@ -40,10 +50,9 @@
 		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
 		"postversion": "git push --follow-tags",
 		"release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version",
-		"depcheck": "depcheck --ignores docdash --ignore-patterns lib/processors/jsdoc/lib/ui5"
+		"depcheck": "depcheck --ignores @ui5/builder,docdash,@istanbuljs/esm-loader-hook,catharsis --parsers='**/*.js:es6,**/*.cjs:es6'"
 	},
 	"files": [
-		"index.js",
 		"CHANGELOG.md",
 		"CONTRIBUTING.md",
 		"jsdoc.json",
@@ -57,6 +66,10 @@
 		],
 		"ignoredByWatcher": [
 			"test/tmp/**"
+		],
+		"nodeArguments": [
+			"--loader=esmock",
+			"--no-warnings"
 		]
 	},
 	"nyc": {
@@ -71,8 +84,8 @@
 			"jsdocs/**",
 			"coverage/**",
 			"test/**",
-			".eslintrc.js",
-			"jsdoc-plugin.js"
+			".eslintrc.cjs",
+			"jsdoc-plugin.cjs"
 		],
 		"check-coverage": true,
 		"statements": 85,
@@ -106,11 +119,11 @@
 	},
 	"dependencies": {
 		"@jridgewell/sourcemap-codec": "^1.4.14",
-		"@ui5/fs": "^3.0.0-alpha.6",
-		"@ui5/logger": "^3.0.1-alpha.2",
+		"@ui5/fs": "^3.0.0-alpha.7",
+		"@ui5/logger": "^3.0.1-alpha.3",
 		"cheerio": "1.0.0-rc.9",
 		"escape-unicode": "^0.2.0",
-		"escope": "^3.6.0",
+		"escope": "^4.0.0",
 		"espree": "^9.3.1",
 		"graceful-fs": "^4.2.9",
 		"jsdoc": "^3.6.7",
@@ -125,8 +138,9 @@
 		"yazl": "^2.5.1"
 	},
 	"devDependencies": {
-		"@ui5/project": "^3.0.0-alpha.7",
-		"ava": "^3.15.0",
+		"@istanbuljs/esm-loader-hook": "^0.2.0",
+		"@ui5/project": "github:SAP/ui5-project#ed265ee31f06728a9ea6d35456feaeada1df42e2",
+		"ava": "^4.3.3",
 		"chai": "^4.3.4",
 		"chai-fs": "^2.0.0",
 		"chokidar-cli": "^3.0.0",
@@ -135,13 +149,14 @@
 		"docdash": "^1.2.0",
 		"eslint": "^8.7.0",
 		"eslint-config-google": "^0.14.0",
+		"eslint-plugin-ava": "^13.2.0",
 		"eslint-plugin-jsdoc": "^37.6.3",
+		"esmock": "^2.0.1",
 		"extract-zip": "^2.0.1",
-		"mock-require": "^3.0.3",
 		"nyc": "^15.1.0",
 		"open-cli": "^6.0.1",
 		"recursive-readdir": "^2.1.1",
-		"sinon": "^11.1.2",
+		"sinon": "^14.0.0",
 		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"
 	}

package/index.js

@@ -1,173 +0,0 @@
-/**
- * @module @ui5/builder
- * @public
- */
-module.exports = {
-	/**
-	 * @public
-	 * @alias module:@ui5/builder.processors
-	 * @namespace
-	 */
-	processors: {
-		/**
-		 * @type {import('./lib/processors/bundlers/flexChangesBundler')}
-		 */
-		flexChangesBundler: "./lib/processors/bundlers/flexChangesBundler",
-		/**
-		 * @type {import('./lib/processors/bundlers/manifestBundler')}
-		 */
-		manifestBundler: "./lib/processors/bundlers/manifestBundler",
-		/**
-		 * @type {import('./lib/processors/bundlers/moduleBundler')}
-		 */
-		moduleBundler: "./lib/processors/bundlers/moduleBundler",
-		/**
-		 * @type {import('./lib/processors/jsdoc/apiIndexGenerator')}
-		 */
-		apiIndexGenerator: "./lib/processors/jsdoc/apiIndexGenerator",
-		/**
-		 * @type {import('./lib/processors/jsdoc/jsdocGenerator')}
-		 */
-		jsdocGenerator: "./lib/processors/jsdoc/jsdocGenerator",
-		/**
-		 * @type {import('./lib/processors/jsdoc/sdkTransformer')}
-		 */
-		sdkTransformer: "./lib/processors/jsdoc/sdkTransformer",
-		/**
-		 * @type {import('./lib/processors/bootstrapHtmlTransformer')}
-		 */
-		bootstrapHtmlTransformer: "./lib/processors/bootstrapHtmlTransformer",
-		/**
-		 * @type {import('./lib/processors/minifier')}
-		 */
-		minifier: "./lib/processors/minifier",
-		/**
-		 * @type {import('./lib/processors/libraryLessGenerator')}
-		 */
-		libraryLessGenerator: "./lib/processors/libraryLessGenerator",
-		/**
-		 * @type {import('./lib/processors/manifestCreator')}
-		 */
-		manifestCreator: "./lib/processors/manifestCreator",
-		/**
-		 * @type {import('./lib/processors/nonAsciiEscaper')}
-		 */
-		nonAsciiEscaper: "./lib/processors/nonAsciiEscaper",
-		/**
-		 * @type {import('./lib/processors/stringReplacer')}
-		 */
-		stringReplacer: "./lib/processors/stringReplacer",
-		/**
-		 * @type {import('./lib/processors/themeBuilder')}
-		 */
-		themeBuilder: "./lib/processors/themeBuilder",
-		/**
-		 * @type {import('./lib/processors/versionInfoGenerator')}
-		 */
-		versionInfoGenerator: "./lib/processors/versionInfoGenerator"
-	},
-	/**
-	 * @public
-	 * @alias module:@ui5/builder.tasks
-	 * @namespace
-	 */
-	tasks: {
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateComponentPreload')}
-		 */
-		generateComponentPreload: "./lib/tasks/bundlers/generateComponentPreload",
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateFlexChangesBundle')}
-		 */
-		generateFlexChangesBundle: "./lib/tasks/bundlers/generateFlexChangesBundle",
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateLibraryPreload')}
-		 */
-		generateLibraryPreload: "./lib/tasks/bundlers/generateLibraryPreload",
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateManifestBundle')}
-		 */
-		generateManifestBundle: "./lib/tasks/bundlers/generateManifestBundle",
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateStandaloneAppBundle')}
-		 */
-		generateStandaloneAppBundle: "./lib/tasks/bundlers/generateStandaloneAppBundle",
-		/**
-		 * @type {import('./lib/tasks/generateThemeDesignerResources')}
-		 */
-		generateThemeDesignerResources: "./lib/tasks/generateThemeDesignerResources",
-		/**
-		 * @type {import('./lib/tasks/bundlers/generateBundle')}
-		 */
-		generateBundle: "./lib/tasks/bundlers/generateBundle",
-		/**
-		 * @type {import('./lib/tasks/generateCachebusterInfo')}
-		 */
-		generateCachebusterInfo: "./lib/tasks/generateCachebusterInfo",
-		/**
-		 * @type {import('./lib/tasks/buildThemes')}
-		 */
-		buildThemes: "./lib/tasks/buildThemes",
-		/**
-		 * @type {import('./lib/tasks/minify')}
-		 */
-		minify: "./lib/tasks/minify",
-		/**
-		 * @type {import('./lib/tasks/jsdoc/executeJsdocSdkTransformation')}
-		 */
-		executeJsdocSdkTransformation: "./lib/tasks/jsdoc/executeJsdocSdkTransformation",
-		/**
-		 * @type {import('./lib/tasks/jsdoc/generateApiIndex')}
-		 */
-		generateApiIndex: "./lib/tasks/jsdoc/generateApiIndex",
-		/**
-		 * @type {import('./lib/tasks/jsdoc/generateJsdoc')}
-		 */
-		generateJsdoc: "./lib/tasks/jsdoc/generateJsdoc",
-		/**
-		 * @type {import('./lib/tasks/generateVersionInfo')}
-		 */
-		generateVersionInfo: "./lib/tasks/generateVersionInfo",
-		/**
-		 * @type {import('./lib/tasks/escapeNonAsciiCharacters')}
-		 */
-		escapeNonAsciiCharacters: "./lib/tasks/escapeNonAsciiCharacters",
-		/**
-		 * @type {import('./lib/tasks/replaceCopyright')}
-		 */
-		replaceCopyright: "./lib/tasks/replaceCopyright",
-		/**
-		 * @type {import('./lib/tasks/replaceVersion')}
-		 */
-		replaceVersion: "./lib/tasks/replaceVersion",
-		/**
-		 * @type {import('./lib/tasks/replaceBuildtime')}
-		 */
-		replaceBuildtime: "./lib/tasks/replaceBuildtime",
-		/**
-		 * @type {import('./lib/tasks/transformBootstrapHtml')}
-		 */
-		transformBootstrapHtml: "./lib/tasks/transformBootstrapHtml",
-		/**
-		 * @type {import('./lib/tasks/taskRepository')}
-		 */
-		taskRepository: "./lib/tasks/taskRepository",
-	}
-};
-
-function exportModules(exportRoot, modulePaths) {
-	for (const moduleName of Object.keys(modulePaths)) {
-		if (typeof modulePaths[moduleName] === "object") {
-			exportRoot[moduleName] = {};
-			exportModules(exportRoot[moduleName], modulePaths[moduleName]);
-		} else {
-			Object.defineProperty(exportRoot, moduleName, {
-				get() {
-					return require(modulePaths[moduleName]);
-				}
-			});
-		}
-	}
-}
-
-exportModules(module.exports, JSON.parse(JSON.stringify(module.exports)));