@ui5/builder 2.11.5 → 3.0.0-alpha.10

package/lib/tasks/generateThemeDesignerResources.js

@@ -3,6 +3,37 @@ const log = require("@ui5/logger").getLogger("builder:tasks:generateThemeDesigne
 const libraryLessGenerator = require("../processors/libraryLessGenerator");
 const {ReaderCollectionPrioritized, Resource, fsInterface} = require("@ui5/fs");
 
+/**
+ * Returns a relative path from the given themeFolder to the root namespace.
+ *
+ * When combining the given themeFolder with the returned relative path it
+ * resolves to "/resources/". However the "/resources/" part is not important
+ * here as it doesn't exist within the theming engine environment where the
+ * UI5 resources are part of a "UI5" folder (e.g. "UI5/sap/ui/core/") that
+ * is next to a "Base" folder.
+ *
+ * @example
+ * getPathToRoot("/resources/sap/ui/foo/themes/base")
+ * > "../../../../../"
+ *
+ * @param {string} themeFolder Virtual path including /resources/
+ * @returns {string} Relative path to root namespace
+ */
+function getPathToRoot(themeFolder) {
+	// -2 for initial "/"" and "resources/"
+	return "../".repeat(themeFolder.split("/").length - 2);
+}
+
+/**
+ * Generates an less import statement for the given <code>filePath</code>
+ *
+ * @param {string} filePath The path to the desired file
+ * @returns {string} The less import statement
+ */
+function lessImport(filePath) {
+	return `@import "${filePath}";\n`;
+}
+
 function generateLibraryDotTheming({namespace, version, hasThemes}) {
 	const dotTheming = {
 		sEntity: "Library",
@@ -80,6 +111,83 @@ async function generateThemeDotTheming({workspace, combo, themeFolder}) {
 	return newDotThemingResource;
 }
 
+async function createCssVariablesLessResource({workspace, combo, themeFolder}) {
+	const pathToRoot = getPathToRoot(themeFolder);
+	const cssVariablesSourceLessFile = "css_variables.source.less";
+	const cssVariablesLessFile = "css_variables.less";
+
+	// posix as it is a virtual path (separated with /)
+	const themeName = posixPath.basename(themeFolder);
+	// The "base" theme of the baseLib is called "baseTheme"
+	const baseLibThemeName = themeName === "base" ? "baseTheme" : themeName;
+
+	// Some themes do not have a base.less file (e.g. sap_hcb)
+	const hasBaseLess = !!(await combo.byPath(`/resources/sap/ui/core/themes/${themeName}/base.less`));
+
+	let cssVariablesLess =
+`/* NOTE: This file was generated as an optimized version of "${cssVariablesSourceLessFile}" \
+for the Theme Designer. */\n\n`;
+
+	if (themeName !== "base") {
+		const cssVariablesSourceLessResource = await workspace.byPath(
+			posixPath.join(themeFolder, cssVariablesSourceLessFile)
+		);
+
+		if (!cssVariablesSourceLessResource) {
+			throw new Error(`Could not find file "${cssVariablesSourceLessFile}" in theme "${themeFolder}"`);
+		}
+
+		const cssVariablesSourceLess = await cssVariablesSourceLessResource.getString();
+
+		cssVariablesLess += lessImport(`../base/${cssVariablesLessFile}`);
+		cssVariablesLess += `
+/* START "${cssVariablesSourceLessFile}" */
+${cssVariablesSourceLess}
+/* END "${cssVariablesSourceLessFile}" */
+
+`;
+	}
+
+	if (hasBaseLess) {
+		cssVariablesLess += lessImport(`${pathToRoot}../Base/baseLib/${baseLibThemeName}/base.less`);
+	}
+	cssVariablesLess += lessImport(`${pathToRoot}sap/ui/core/themes/${themeName}/global.less`);
+
+	return new Resource({
+		path: posixPath.join(themeFolder, cssVariablesLessFile),
+		string: cssVariablesLess
+	});
+}
+
+async function generateCssVariablesLess({workspace, combo, namespace}) {
+	let cssVariablesSourceLessResourcePattern;
+	if (namespace) {
+		// In case of a library only check for themes directly below the namespace
+		cssVariablesSourceLessResourcePattern = `/resources/${namespace}/themes/*/css_variables.source.less`;
+	} else {
+		// In case of a theme-library check for all "themes"
+		cssVariablesSourceLessResourcePattern = `/resources/**/themes/*/css_variables.source.less`;
+	}
+
+	const cssVariablesSourceLessResource = await workspace.byGlob(cssVariablesSourceLessResourcePattern);
+
+	const hasCssVariables = cssVariablesSourceLessResource.length > 0;
+
+	if (hasCssVariables) {
+		await Promise.all(
+			cssVariablesSourceLessResource.map(async (cssVariableSourceLess) => {
+				const themeFolder = posixPath.dirname(cssVariableSourceLess.getPath());
+				log.verbose(`Generating css_variables.less for theme ${themeFolder}`);
+				const r = await createCssVariablesLessResource({
+					workspace, combo, themeFolder
+				});
+				return await workspace.write(r);
+			})
+		);
+	}
+}
+
+/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
 /**
  * Generates resources required for integration with the SAP Theme Designer.
  *
@@ -91,11 +199,16 @@ async function generateThemeDotTheming({workspace, combo, themeFolder}) {
  * @param {object} parameters.options Options
  * @param {string} parameters.options.projectName Project name
  * @param {string} parameters.options.version Project version
- * @param {string} [parameters.options.namespace] If the project is of type <code>library</code>, provide its namespace.
+ * @param {string} [parameters.options.projectNamespace] If the project is of type <code>library</code>,
+ * 														 provide its 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: {projectName, version, namespace}}) {
+module.exports = async function({workspace, dependencies, options}) {
+	const {projectName, version} = options;
+	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
+	const namespace = options.projectNamespace || options.namespace;
+
 	// Skip sap.ui.documentation since it is not intended to be available in SAP Theme Designer to create custom themes
 	if (namespace === "sap/ui/documentation") {
 		return;
@@ -163,4 +276,7 @@ module.exports = async function({workspace, dependencies, options: {projectName,
 	await Promise.all(
 		libraryLessResources.map((resource) => workspace.write(resource))
 	);
+
+	// css_variables.less
+	await generateCssVariablesLess({workspace, combo, namespace});
 };

package/lib/tasks/generateVersionInfo.js

@@ -19,7 +19,7 @@ module.exports = async ({workspace, dependencies, options: {rootProject, pattern
 	const resources = await dependencies.byGlob(pattern);
 
 	const libraryInfosPromises = resources.map((dotLibResource) => {
-		const namespace = dotLibResource._project.metadata.namespace;
+		const namespace = dotLibResource.getProject().getNamespace();
 		// pass all required resources to the processor
 		// the processor will then filter
 		return dependencies.byGlob(`/resources/${namespace}/**/${MANIFEST_JSON}`).then((manifestResources) => {
@@ -31,8 +31,8 @@ module.exports = async ({workspace, dependencies, options: {rootProject, pattern
 			return {
 				libraryManifest,
 				embeddedManifests,
-				name: dotLibResource._project.metadata.name,
-				version: dotLibResource._project.version
+				name: dotLibResource.getProject().getName(),
+				version: dotLibResource.getProject().getVersion()
 			};
 		});
 	});
@@ -40,8 +40,8 @@ module.exports = async ({workspace, dependencies, options: {rootProject, pattern
 
 	const [versionInfoResource] = await versionInfoGenerator({
 		options: {
-			rootProjectName: rootProject.metadata.name,
-			rootProjectVersion: rootProject.version,
+			rootProjectName: rootProject.getName(),
+			rootProjectVersion: rootProject.getVersion(),
 			libraryInfos
 		}
 	});

package/lib/tasks/jsdoc/generateJsdoc.js

@@ -28,7 +28,7 @@ const {resourceFactory} = require("@ui5/fs");
  * @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/builder.tasks.TaskUtil|object} [parameters.taskUtil] TaskUtil
+ * @param {module:@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
  */

package/lib/tasks/minify.js

@@ -0,0 +1,41 @@
+const minifier = require("../processors/minifier");
+
+/**
+ * Task to minify resources.
+ *
+ * @public
+ * @alias module:@ui5/builder.tasks.minify
+ * @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 {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}}) {
+	const resources = await workspace.byGlob(pattern);
+	const processedResources = await minifier({
+		resources,
+		options: {
+			addSourceMappingUrl: !omitSourceMapResources
+		}
+	});
+
+	return Promise.all(processedResources.map(async ({resource, dbgResource, sourceMapResource}) => {
+		if (taskUtil) {
+			taskUtil.setTag(resource, taskUtil.STANDARD_TAGS.HasDebugVariant);
+			taskUtil.setTag(dbgResource, taskUtil.STANDARD_TAGS.IsDebugVariant);
+			taskUtil.setTag(sourceMapResource, taskUtil.STANDARD_TAGS.HasDebugVariant);
+			if (omitSourceMapResources) {
+				taskUtil.setTag(sourceMapResource, taskUtil.STANDARD_TAGS.OmitFromBuildResult);
+			}
+		}
+		return Promise.all([
+			workspace.write(resource),
+			workspace.write(dbgResource),
+			workspace.write(sourceMapResource)
+		]);
+	}));
+};

package/lib/tasks/replaceVersion.js

@@ -18,7 +18,7 @@ module.exports = function({workspace, options: {pattern, version}}) {
 			return stringReplacer({
 				resources: allResources,
 				options: {
-					pattern: "${version}",
+					pattern: /\$\{(?:project\.)?version\}/g,
 					replacement: version
 				}
 			});

package/lib/tasks/taskRepository.js

@@ -2,12 +2,11 @@ const taskInfos = {
 	replaceCopyright: {path: "./replaceCopyright"},
 	replaceVersion: {path: "./replaceVersion"},
 	replaceBuildtime: {path: "./replaceBuildtime"},
-	createDebugFiles: {path: "./createDebugFiles"},
 	escapeNonAsciiCharacters: {path: "./escapeNonAsciiCharacters"},
 	executeJsdocSdkTransformation: {path: "./jsdoc/executeJsdocSdkTransformation"},
 	generateApiIndex: {path: "./jsdoc/generateApiIndex"},
 	generateJsdoc: {path: "./jsdoc/generateJsdoc"},
-	uglify: {path: "./uglify"},
+	minify: {path: "./minify"},
 	buildThemes: {path: "./buildThemes"},
 	transformBootstrapHtml: {path: "./transformBootstrapHtml"},
 	generateLibraryManifest: {path: "./generateLibraryManifest"},
@@ -27,35 +26,28 @@ function getTask(taskName) {
 	const taskInfo = taskInfos[taskName];
 
 	if (!taskInfo) {
+		if (["createDebugFiles", "uglify"].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/`);
+		}
 		throw new Error(`taskRepository: Unknown Task ${taskName}`);
 	}
 	try {
 		const task = require(taskInfo.path);
 		return {
-			task,
-			specVersion: taskInfo.specVersion
+			task
 		};
 	} catch (err) {
 		throw new Error(`taskRepository: Failed to require task module for ${taskName}: ${err.message}`);
 	}
 }
 
-function addTask({name, specVersion, taskPath}) {
-	if (taskInfos[name]) {
-		throw new Error(`taskRepository: A task with the name ${name} has already been registered`);
-	}
-	taskInfos[name] = {
-		path: taskPath,
-		specVersion
-	};
-}
-
 function getAllTaskNames() {
 	return Object.keys(taskInfos);
 }
 
 module.exports = {
 	getTask,
-	addTask,
 	getAllTaskNames
 };

package/lib/tasks/transformBootstrapHtml.js

@@ -1,6 +1,7 @@
 const log = require("@ui5/logger").getLogger("builder:tasks:transformBootstrapHtml");
 const bootstrapHtmlTransformer = require("../processors/bootstrapHtmlTransformer");
 
+/* eslint "jsdoc/check-param-names": ["error", {"disableExtraPropertyReporting":true}] */
 /**
  * Task for transforming the application bootstrap HTML file.
  *
@@ -12,7 +13,11 @@ const bootstrapHtmlTransformer = require("../processors/bootstrapHtmlTransformer
  * @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: {projectName, namespace}}) {
+module.exports = async function({workspace, options}) {
+	const {projectName} = options;
+	// Backward compatibility: "namespace" option got renamed to "projectNamespace"
+	const namespace = options.projectNamespace || options.namespace;
+
 	let indexPath;
 	if (namespace) {
 		indexPath = `/resources/${namespace}/index.html`;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "2.11.5",
+	"version": "3.0.0-alpha.10",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -18,8 +18,8 @@
 	],
 	"main": "index.js",
 	"engines": {
-		"node": ">= 10",
-		"npm": ">= 5"
+		"node": ">= 16.13.2",
+		"npm": ">= 8"
 	},
 	"scripts": {
 		"test": "npm run lint && npm run jsdoc-generate && npm run coverage && npm run depcheck",
@@ -34,16 +34,17 @@
 		"coverage": "nyc npm run unit",
 		"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": "node_modules/.bin/jsdoc -c ./jsdoc.json ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
+		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
 		"jsdoc-watch": "npm run jsdoc && chokidar \"./lib/**/*.js\" -c \"npm run jsdoc-generate\"",
 		"preversion": "npm test",
-		"version": "git-chglog --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
+		"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 -c .chglog/release-config.yml v$npm_package_version",
-		"depcheck": "depcheck --ignores docdash"
+		"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"
 	},
 	"files": [
 		"index.js",
+		"CHANGELOG.md",
 		"CONTRIBUTING.md",
 		"jsdoc.json",
 		"lib/**",
@@ -104,37 +105,37 @@
 		"url": "git@github.com:SAP/ui5-builder.git"
 	},
 	"dependencies": {
-		"@ui5/fs": "^2.0.6",
-		"@ui5/logger": "^2.0.1",
+		"@jridgewell/sourcemap-codec": "^1.4.14",
+		"@ui5/fs": "^3.0.0-alpha.6",
+		"@ui5/logger": "^3.0.1-alpha.2",
 		"cheerio": "1.0.0-rc.9",
 		"escape-unicode": "^0.2.0",
 		"escope": "^3.6.0",
-		"espree": "^6.2.1",
-		"globby": "^11.1.0",
-		"graceful-fs": "^4.2.10",
-		"jsdoc": "^3.6.10",
+		"espree": "^9.3.1",
+		"graceful-fs": "^4.2.9",
+		"jsdoc": "^3.6.7",
 		"less-openui5": "^0.11.2",
 		"make-dir": "^3.1.0",
 		"pretty-data": "^0.40.0",
-		"pretty-hrtime": "^1.0.3",
 		"replacestream": "^4.0.3",
 		"rimraf": "^3.0.2",
-		"semver": "^7.3.7",
-		"terser": "^5.13.1",
+		"semver": "^7.3.5",
+		"terser": "^5.14.2",
 		"xml2js": "^0.4.23",
 		"yazl": "^2.5.1"
 	},
 	"devDependencies": {
+		"@ui5/project": "^3.0.0-alpha.7",
 		"ava": "^3.15.0",
-		"chai": "^4.3.6",
+		"chai": "^4.3.4",
 		"chai-fs": "^2.0.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
 		"docdash": "^1.2.0",
-		"eslint": "^7.32.0",
+		"eslint": "^8.7.0",
 		"eslint-config-google": "^0.14.0",
-		"eslint-plugin-jsdoc": "^37.9.7",
+		"eslint-plugin-jsdoc": "^37.6.3",
 		"extract-zip": "^2.0.1",
 		"mock-require": "^3.0.3",
 		"nyc": "^15.1.0",

package/lib/builder/BuildContext.js

@@ -1,39 +0,0 @@
-const ProjectBuildContext = require("./ProjectBuildContext");
-
-/**
- * Context of a build process
- *
- * @private
- * @memberof module:@ui5/builder.builder
- */
-class BuildContext {
-	constructor({rootProject}) {
-		if (!rootProject) {
-			throw new Error(`Missing parameter 'rootProject'`);
-		}
-		this.rootProject = rootProject;
-		this.projectBuildContexts = [];
-	}
-
-	getRootProject() {
-		return this.rootProject;
-	}
-
-	createProjectContext({project, resources}) {
-		const projectBuildContext = new ProjectBuildContext({
-			buildContext: this,
-			project,
-			resources
-		});
-		this.projectBuildContexts.push(projectBuildContext);
-		return projectBuildContext;
-	}
-
-	async executeCleanupTasks() {
-		await Promise.all(this.projectBuildContexts.map((ctx) => {
-			return ctx.executeCleanupTasks();
-		}));
-	}
-}
-
-module.exports = BuildContext;

package/lib/builder/ProjectBuildContext.js

@@ -1,55 +0,0 @@
-const ResourceTagCollection = require("@ui5/fs").ResourceTagCollection;
-
-// Note: When adding standard tags, always update the public documentation in TaskUtil
-// (Type "module:@ui5/builder.tasks.TaskUtil~StandardBuildTags")
-const STANDARD_TAGS = Object.freeze({
-	OmitFromBuildResult: "ui5:OmitFromBuildResult",
-	IsBundle: "ui5:IsBundle"
-});
-
-/**
- * Build context of a single project. Always part of an overall
- * [Build Context]{@link module:@ui5/builder.builder.BuildContext}
- *
- * @private
- * @memberof module:@ui5/builder.builder
- */
-class ProjectBuildContext {
-	constructor({buildContext, project, resources}) {
-		if (!buildContext || !project || !resources) {
-			throw new Error(`One or more mandatory parameters are missing`);
-		}
-		this._buildContext = buildContext;
-		this._project = project;
-		// this.resources = resources;
-		this.queues = {
-			cleanup: []
-		};
-
-		this.STANDARD_TAGS = STANDARD_TAGS;
-
-		this._resourceTagCollection = new ResourceTagCollection({
-			allowedTags: Object.values(this.STANDARD_TAGS)
-		});
-	}
-
-	isRootProject() {
-		return this._project === this._buildContext.getRootProject();
-	}
-
-	registerCleanupTask(callback) {
-		this.queues.cleanup.push(callback);
-	}
-
-	async executeCleanupTasks() {
-		await Promise.all(this.queues.cleanup.map((callback) => {
-			return callback();
-		}));
-	}
-
-	getResourceTagCollection() {
-		return this._resourceTagCollection;
-	}
-}
-
-module.exports = ProjectBuildContext;