@ui5/builder 3.0.0-rc.0 → 3.0.0-rc.2

package/.reuse/dep5

@@ -25,9 +25,9 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
  parties the right to use of access any SAP External Product, through API Calls.
 
 Files: *
-Copyright: 2018-2022 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+Copyright: 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 License: Apache-2.0
 
 Files: lib/processors/jsdoc/lib/*
-Copyright: 2009-2022 SAP SE or an SAP affiliate company and OpenUI5 contributors
+Copyright: 2009-2023 SAP SE or an SAP affiliate company and OpenUI5 contributors
 License: Apache-2.0

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-rc.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-builder/compare/v3.0.0-rc.2...HEAD).
+
+<a name="v3.0.0-rc.2"></a>
+## [v3.0.0-rc.2] - 2023-01-22
+### Dependency Updates
+- Bump rimraf from 3.0.2 to 4.1.1 ([#873](https://github.com/SAP/ui5-builder/issues/873)) [`ddb9660`](https://github.com/SAP/ui5-builder/commit/ddb96602fea5b96ba37afdebda0993d847462f52)
+
+
+<a name="v3.0.0-rc.1"></a>
+## [v3.0.0-rc.1] - 2023-01-11
+### Breaking Changes
+- **libraryLessGenerator:** Throw error when import can't be inlined [`d2be9bb`](https://github.com/SAP/ui5-builder/commit/d2be9bb68600ec97b9bc007f348f87ad456fb5a3)
+
 
 <a name="v3.0.0-rc.0"></a>
 ## [v3.0.0-rc.0] - 2022-12-23
@@ -831,6 +843,8 @@ to load the custom bundle file instead.
 - Add ability to configure component preloads and custom bundles [`2241e5f`](https://github.com/SAP/ui5-builder/commit/2241e5ff98fd95f1f80cc74959655ae7a9c660e7)
 
 
+[v3.0.0-rc.2]: https://github.com/SAP/ui5-builder/compare/v3.0.0-rc.1...v3.0.0-rc.2
+[v3.0.0-rc.1]: https://github.com/SAP/ui5-builder/compare/v3.0.0-rc.0...v3.0.0-rc.1
 [v3.0.0-rc.0]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.6...v3.0.0-rc.0
 [v3.0.0-beta.6]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.5...v3.0.0-beta.6
 [v3.0.0-beta.5]: https://github.com/SAP/ui5-builder/compare/v3.0.0-beta.4...v3.0.0-beta.5

package/LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2021 SAP SE or an SAP affiliate company and UI5 Tooling contributors
+   Copyright 2018-2023 SAP SE or an SAP affiliate company and UI5 Tooling contributors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -10,7 +10,9 @@
 [![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-builder/badge.svg)](https://coveralls.io/github/SAP/ui5-builder)
 
 ## Documentation
-Can be found here: [sap.github.io/ui5-tooling](https://sap.github.io/ui5-tooling/pages/Builder/)
+UI5 Builder documentation can be found here: [sap.github.io/ui5-tooling](https://sap.github.io/ui5-tooling/v3/pages/Builder/)
+
+The UI5 Builder API Reference can be found here: [`@ui5/builder`](https://sap.github.io/ui5-tooling/v3/api/)
 
 ## Contributing
 Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/main/CONTRIBUTING.md).

package/lib/processors/libraryLessGenerator.js

@@ -9,14 +9,6 @@ const IMPORT_PATTERN = /@import .*"(.*)";/g;
 const BASE_LESS_PATTERN = /^\/resources\/sap\/ui\/core\/themes\/([^/]+)\/base\.less$/;
 const GLOBAL_LESS_PATTERN = /^\/resources\/sap\/ui\/core\/themes\/([^/]+)\/global\.less$/;
 
-class ImportError extends Error {
-	constructor(message) {
-		super();
-		this.name = "ImportError";
-		this.message = message;
-	}
-}
-
 class LibraryLessGenerator {
 	constructor({fs}) {
 		const readFile = promisify(fs.readFile);
@@ -42,17 +34,7 @@ class LibraryLessGenerator {
 		const replacements = await Promise.all(imports.map(async (importMatch) => {
 			const baseDir = posixPath.dirname(filePath);
 			const resolvedFilePath = posixPath.resolve(baseDir, importMatch.path);
-			try {
-				importMatch.content = await this.resolveLessImport(importMatch.path, resolvedFilePath, baseDir);
-			} catch (error) {
-				if (error instanceof ImportError) {
-					// Add message of import errors after the import statements
-					// Currently those errors should not break the build (see comments in resolveLessImport)
-					importMatch.content = importMatch.fullMatch + ` /* ${error} */`;
-				} else {
-					throw error;
-				}
-			}
+			importMatch.content = await this.resolveLessImport(importMatch.path, resolvedFilePath, baseDir);
 			return importMatch;
 		}));
 
@@ -97,26 +79,19 @@ class LibraryLessGenerator {
 		}
 
 		/*
-		 * Log error in case of files which are not in the same directory as the current file because
+		 * Throw error in case of files which are not in the same directory as the current file because
 		 * inlining them would break relative URLs.
 		 * A possible solution would be to rewrite relative URLs when inlining the content.
 		 *
 		 * Keeping the import will cause errors since only "library.less" and "global.less" are
 		 * configured to be available to the Theme Designer (.theming generated in generateThemeDesignerResources).
-		 * However, the previous implementation did not break the build.
-		 * In many cases the library.less file is currently not relevant so breaking the build would cause
-		 * unnecessary issues.
-		 *
 		 */
 		const relativeFilePath = posixPath.relative(baseDir, resolvedFilePath);
 		if (relativeFilePath.includes(posixPath.sep)) {
-			log.error(
+			throw new Error(
 				`Could not inline import '${resolvedFilePath}' outside of theme directory '${baseDir}'. ` +
-				`Stylesheets must be located in the theme directory (no sub-directories). ` +
-				`The generated '${baseDir}/library.less' will cause errors when compiled with the Theme Designer.`
+				`Stylesheets must be located in the theme directory (no sub-directories).`
 			);
-			// Throw error to be added as comment to the import statement
-			throw new ImportError("Could not inline import outside of theme directory");
 		}
 
 		let importedFileContent;
@@ -145,7 +120,6 @@ class LibraryLessGenerator {
 		while ((match = IMPORT_PATTERN.exec(fileContent)) !== null) {
 			imports.push({
 				path: match[1],
-				fullMatch: match[0],
 				matchStart: match.index,
 				matchLength: match[0].length
 			});

package/lib/processors/stringReplacer.js

@@ -1,5 +1,3 @@
-import replaceStream from "replacestream";
-
 /**
  * @public
  * @module @ui5/builder/processors/stringReplacer
@@ -20,12 +18,12 @@ import replaceStream from "replacestream";
  * @returns {Promise<@ui5/fs/Resource[]>} Promise resolving with modified resources
  */
 export default function({resources, options: {pattern, replacement}}) {
-	return Promise.all(resources.map((resource) => {
-		let stream = resource.getStream();
-		stream.setEncoding("utf8");
-		stream = stream.pipe(replaceStream(pattern, replacement));
-
-		resource.setStream(stream);
+	return Promise.all(resources.map(async (resource) => {
+		const content = await resource.getString();
+		const newContent = content.replaceAll(pattern, replacement);
+		if (content !== newContent) {
+			resource.setString(newContent);
+		}
 		return resource;
 	}));
 }

package/lib/tasks/jsdoc/generateJsdoc.js

@@ -3,11 +3,10 @@ const log = logger.getLogger("builder:tasks:jsdoc:generateJsdoc");
 import path from "node:path";
 import os from "node:os";
 import fs from "graceful-fs";
-import _rimraf from "rimraf";
+import rimraf from "rimraf";
 import {promisify} from "node:util";
 const mkdtemp = promisify(fs.mkdtemp);
 const mkdir = promisify(fs.mkdir);
-const rimraf = promisify(_rimraf);
 import jsdocGenerator from "../../processors/jsdoc/jsdocGenerator.js";
 import {createAdapter} from "@ui5/fs/resourceFactory";
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/builder",
-	"version": "3.0.0-rc.0",
+	"version": "3.0.0-rc.2",
 	"description": "UI5 Tooling - Builder",
 	"author": {
 		"name": "SAP SE",
@@ -38,7 +38,6 @@
 		"unit": "rimraf test/tmp && ava",
 		"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 --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": "rimraf test/tmp && nyc ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\"",
@@ -119,42 +118,40 @@
 	},
 	"dependencies": {
 		"@jridgewell/sourcemap-codec": "^1.4.14",
-		"@ui5/fs": "^3.0.0-rc.0",
-		"@ui5/logger": "^3.0.1-rc.0",
+		"@ui5/fs": "^3.0.0-rc.3",
+		"@ui5/logger": "^3.0.1-rc.1",
 		"cheerio": "1.0.0-rc.12",
 		"escape-unicode": "^0.2.0",
 		"escope": "^4.0.0",
 		"espree": "^9.4.1",
 		"graceful-fs": "^4.2.10",
 		"jsdoc": "^3.6.11",
-		"less-openui5": "^0.11.5",
+		"less-openui5": "^0.11.6",
 		"pretty-data": "^0.40.0",
-		"replacestream": "^4.0.3",
-		"rimraf": "^3.0.2",
+		"rimraf": "^4.1.1",
 		"semver": "^7.3.8",
 		"terser": "^5.16.1",
 		"xml2js": "^0.4.23"
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
-		"@ui5/project": "^3.0.0-beta.5",
-		"ava": "^5.1.0",
+		"@ui5/project": "^3.0.0-rc.3",
+		"ava": "^5.1.1",
 		"chai": "^4.3.7",
 		"chai-fs": "^2.0.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
-		"docdash": "^2.0.0",
-		"eslint": "^8.30.0",
+		"docdash": "^2.0.1",
+		"eslint": "^8.32.0",
 		"eslint-config-google": "^0.14.0",
-		"eslint-plugin-ava": "^13.2.0",
-		"eslint-plugin-jsdoc": "^39.6.4",
+		"eslint-plugin-ava": "^14.0.0",
+		"eslint-plugin-jsdoc": "^39.6.7",
 		"esmock": "^2.1.0",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.1.0",
 		"recursive-readdir": "^2.2.3",
 		"sinon": "^15.0.1",
-		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"
 	}
 }