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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.0.0-alpha.9",
+	"version": "3.0.0-beta.2",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -16,9 +16,19 @@
 		"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",
+		"node": "^16.18.0 || >=18.0.0",
 		"npm": ">= 8"
 	},
 	"scripts": {
@@ -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,42 +119,42 @@
 	},
 	"dependencies": {
 		"@jridgewell/sourcemap-codec": "^1.4.14",
-		"@ui5/fs": "^3.0.0-alpha.5",
-		"@ui5/logger": "^3.0.1-alpha.1",
-		"cheerio": "1.0.0-rc.9",
+		"@ui5/fs": "^3.0.0-beta.3",
+		"@ui5/logger": "^3.0.1-beta.1",
+		"cheerio": "1.0.0-rc.12",
 		"escape-unicode": "^0.2.0",
-		"escope": "^3.6.0",
-		"espree": "^9.3.1",
-		"graceful-fs": "^4.2.9",
-		"jsdoc": "^3.6.7",
+		"escope": "^4.0.0",
+		"espree": "^9.4.1",
+		"graceful-fs": "^4.2.10",
+		"jsdoc": "^3.6.11",
 		"less-openui5": "^0.11.2",
 		"make-dir": "^3.1.0",
 		"pretty-data": "^0.40.0",
 		"replacestream": "^4.0.3",
 		"rimraf": "^3.0.2",
-		"semver": "^7.3.5",
-		"terser": "^5.14.2",
-		"xml2js": "^0.4.23",
-		"yazl": "^2.5.1"
+		"semver": "^7.3.8",
+		"terser": "^5.16.0",
+		"xml2js": "^0.4.23"
 	},
 	"devDependencies": {
-		"@ui5/project": "^3.0.0-alpha.6",
-		"ava": "^3.15.0",
-		"chai": "^4.3.4",
+		"@istanbuljs/esm-loader-hook": "^0.2.0",
+		"@ui5/project": "^3.0.0-beta.3",
+		"ava": "^5.1.0",
+		"chai": "^4.3.7",
 		"chai-fs": "^2.0.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
-		"docdash": "^1.2.0",
-		"eslint": "^8.7.0",
+		"docdash": "^2.0.0",
+		"eslint": "^8.28.0",
 		"eslint-config-google": "^0.14.0",
-		"eslint-plugin-jsdoc": "^37.6.3",
-		"extract-zip": "^2.0.1",
-		"mock-require": "^3.0.3",
+		"eslint-plugin-ava": "^13.2.0",
+		"eslint-plugin-jsdoc": "^39.6.4",
+		"esmock": "^2.0.9",
 		"nyc": "^15.1.0",
-		"open-cli": "^6.0.1",
-		"recursive-readdir": "^2.1.1",
-		"sinon": "^11.1.2",
+		"open-cli": "^7.1.0",
+		"recursive-readdir": "^2.2.3",
+		"sinon": "^14.0.2",
 		"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)));

package/lib/processors/bundlers/manifestBundler.js

@@ -1,172 +0,0 @@
-const posixPath = require("path").posix;
-const yazl = require("yazl");
-const resourceFactory = require("@ui5/fs").resourceFactory;
-const log = require("@ui5/logger").getLogger("builder:processors:bundlers:manifestBundler");
-
-/**
- * Repository to handle i18n resource files
- *
- * @private
- */
-class I18nResourceList {
-	/**
-	 * Constructor
-	 */
-	constructor() {
-		this.propertyFiles = new Map();
-	}
-
-	/**
-	 * Adds a i18n resource to the repository
-	 *
-	 * @param {string} directory Path to the i18n resource
-	 * @param {module:@ui5/fs.Resource} resource i18n resource
-	 */
-	add(directory, resource) {
-		const normalizedDirectory = posixPath.normalize(directory);
-		if (!this.propertyFiles.has(normalizedDirectory)) {
-			this.propertyFiles.set(normalizedDirectory, [resource]);
-		} else {
-			this.propertyFiles.get(normalizedDirectory).push(resource);
-		}
-	}
-
-	/**
-	 * Gets all registered i18n files within the provided path
-	 *
-	 * @param {string} directory Path to search for
-	 * @returns {Array} Array of resources files
-	 */
-	get(directory) {
-		return this.propertyFiles.get(posixPath.normalize(directory)) || [];
-	}
-}
-
-/**
- * Creates a manifest bundle from the provided resources.
- *
- * @alias module:@ui5/builder.processors.manifestBundler
- * @public
- * @param {object} parameters Parameters
- * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources to be processed
- * @param {object} parameters.options Options
- * @param {string} parameters.options.namespace Namespace of the project
- * @param {string} parameters.options.bundleName Name of the bundled zip file
- * @param {string} parameters.options.propertiesExtension Extension name of the properties files, e.g. ".properties"
- * @param {string} parameters.options.descriptor Descriptor name
- * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with manifest bundle resources
- */
-module.exports = ({resources, options: {namespace, bundleName, propertiesExtension, descriptor}}) => {
-	function bundleNameToUrl(bundleName, appId) {
-		if (!bundleName.startsWith(appId)) {
-			return null;
-		}
-		const relativeBundleName = bundleName.substring(appId.length + 1);
-		return relativeBundleName.replace(/\./g, "/") + propertiesExtension;
-	}
-
-	function addDescriptorI18nInfos(descriptorI18nInfos, manifest) {
-		function addI18nInfo(i18nPath) {
-			if (i18nPath.startsWith("ui5:")) {
-				log.warn(`Using the ui5:// protocol for i18n bundles is currently not supported ('${i18nPath}' in ${manifest.path})`);
-				return;
-			}
-			descriptorI18nInfos.set(
-				posixPath.join(posixPath.dirname(manifest.path), posixPath.dirname(i18nPath)),
-				posixPath.basename(i18nPath, propertiesExtension)
-			);
-		}
-
-		const content = JSON.parse(manifest.content);
-		const appI18n = content["sap.app"]["i18n"];
-		let bundleUrl;
-		// i18n section in sap.app can be either a string or an object with bundleUrl
-		if (typeof appI18n === "object") {
-			if (appI18n.bundleUrl) {
-				bundleUrl = appI18n.bundleUrl;
-			} else if (appI18n.bundleName) {
-				bundleUrl = bundleNameToUrl(appI18n.bundleName, content["sap.app"]["id"]);
-			}
-		} else if (typeof appI18n === "string") {
-			bundleUrl = appI18n;
-		} else {
-			bundleUrl = "i18n/i18n.properties";
-		}
-		if (bundleUrl) {
-			addI18nInfo(bundleUrl);
-		}
-
-		if (typeof appI18n === "object" && Array.isArray(appI18n.enhanceWith)) {
-			appI18n.enhanceWith.forEach((enhanceWithEntry) => {
-				let bundleUrl;
-				if (enhanceWithEntry.bundleUrl) {
-					bundleUrl = enhanceWithEntry.bundleUrl;
-				} else if (enhanceWithEntry.bundleName) {
-					bundleUrl = bundleNameToUrl(enhanceWithEntry.bundleName, content["sap.app"]["id"]);
-				}
-				if (bundleUrl) {
-					addI18nInfo(bundleUrl);
-				}
-			});
-		}
-	}
-
-	return Promise.all(resources.map((resource) =>
-		resource.getBuffer().then((content) => {
-			const basename = posixPath.basename(resource.getPath());
-			return {
-				name: basename,
-				isManifest: basename === descriptor,
-				path: resource.getPath(),
-				content: content
-			};
-		})
-	)).then((resources) => {
-		const archiveContent = new Map();
-		const descriptorI18nInfos = new Map();
-		const i18nResourceList = new I18nResourceList();
-
-		resources.forEach((resource) => {
-			if (resource.isManifest) {
-				addDescriptorI18nInfos(descriptorI18nInfos, resource);
-				archiveContent.set(resource.path, resource.content);
-			} else {
-				const directory = posixPath.dirname(resource.path);
-				i18nResourceList.add(directory, resource);
-			}
-		});
-
-		descriptorI18nInfos.forEach((rootName, directory) => {
-			const i18nResources = i18nResourceList.get(directory)
-				.filter((resource) => resource.name.startsWith(rootName));
-
-			if (i18nResources.length) {
-				i18nResources.forEach((resource) => archiveContent.set(resource.path, resource.content));
-			} else {
-				log.warn(`Could not find any resources for i18n bundle '${directory}'`);
-			}
-		});
-
-		return archiveContent;
-	}).then((archiveContent) => new Promise((resolve) => {
-		const zip = new yazl.ZipFile();
-		const basePath = `/resources/${namespace}/`;
-		archiveContent.forEach((content, path) => {
-			if (!path.startsWith(basePath)) {
-				log.verbose(`Not bundling resource with path ${path} since it is not based on path ${basePath}`);
-				return;
-			}
-			// Remove base path. Absolute paths are not allowed in ZIP files
-			const normalizedPath = path.replace(basePath, "");
-			zip.addBuffer(content, normalizedPath);
-		});
-		zip.end();
-
-		const pathPrefix = "/resources/" + namespace + "/";
-		const res = resourceFactory.createResource({
-			path: pathPrefix + bundleName,
-			stream: zip.outputStream
-		});
-		resolve([res]);
-	}));
-};

package/lib/tasks/bundlers/generateManifestBundle.js

@@ -1,49 +0,0 @@
-const log = require("@ui5/logger").getLogger("builder:tasks:bundlers:generateManifestBundle");
-const manifestBundler = require("../../processors/bundlers/manifestBundler");
-const DESCRIPTOR = "manifest.json";
-const PROPERTIES_EXT = ".properties";
-const BUNDLE_NAME = "manifest-bundle.zip";
-
-/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
-/**
- * Task for manifestBundler.
- *
- * @public
- * @alias module:@ui5/builder.tasks.generateManifestBundle
- * @param {object} parameters Parameters
- * @param {module:@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.projectNamespace Project namespace
- * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
- */
-module.exports = async function({workspace, options = {}}) {
-	const {projectName} = options;
-	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
-	const namespace = options.projectNamespace || options.namespace;
-
-	if (!projectName || !namespace) {
-		throw new Error("[generateManifestBundle]: One or more mandatory options not provided");
-	}
-
-	const allResources = await workspace.byGlob(`/resources/${namespace}/**/{${DESCRIPTOR},*${PROPERTIES_EXT}}`);
-	if (allResources.length === 0) {
-		log.verbose(`Could not find a "${DESCRIPTOR}" file for project ${projectName}, ` +
-			`creation of "${BUNDLE_NAME}" is skipped!`);
-		return;
-	}
-
-	const processedResources = await manifestBundler({
-		resources: allResources,
-		options: {
-			descriptor: DESCRIPTOR,
-			propertiesExtension: PROPERTIES_EXT,
-			bundleName: BUNDLE_NAME,
-			namespace
-		}
-	});
-
-	await Promise.all(processedResources.map((resource) => {
-		return workspace.write(resource);
-	}));
-};