cds-plugin-ui5 0.8.2 → 0.9.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.9.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.8.3...cds-plugin-ui5@0.9.0) (2024-05-13)
+
+
+### Features
+
+* **cds-plugin-ui5:** sanitizing package.json with cds build task for gen/srv ([#999](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/999)) ([d52386c](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/d52386c168c62ea4c827cfff65be78117e13fd12))
+
+
+
+
+
+## [0.8.3](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.8.2...cds-plugin-ui5@0.8.3) (2024-03-30)
+
+
+### Bug Fixes
+
+* cleanup of dependencies and improved approuter logic ([#984](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/984)) ([65ffaed](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/65ffaedb7968015e008e2eb6aa66ff1e0a03a73a))
+
+
+
+
+
 ## [0.8.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.8.1...cds-plugin-ui5@0.8.2) (2024-03-04)
 
 

package/cds-plugin.js

@@ -190,4 +190,75 @@ if (!skip) {
 		// bootstrap completed, unlock the "served" event
 		bootstrapped();
 	});
+
+	// check if the register function for build tasks is available at the cds object
+	// and if the Plugin class is available to register the cds build task
+	if (typeof cds.build?.register === "function" && typeof cds.build?.Plugin?.constructor === "function") {
+		const { readFile, writeFile } = require("fs").promises;
+		const { existsSync } = require("fs");
+		const { join } = require("path");
+		const { minVersion } = require("semver");
+		const util = require("util");
+		const exec = util.promisify(require("child_process").exec);
+
+		// helper to check whether a semantic version is valid
+		const valid = (version) => {
+			try {
+				return minVersion(version) !== null;
+			} catch (e) {
+				return false;
+			}
+		};
+
+		// register the cds build task to sanitize the package.json and update the package-lock.json
+		cds.build.register(
+			"ui5",
+			class UI5Plugin extends cds.build.Plugin {
+				static taskDefaults = { src: cds.env.folders.srv };
+				static hasTask() {
+					return true;
+				}
+				init() {}
+				clean() {
+					this._priority = -1; // hack to ensure that the clean task is executed last!
+				}
+				get priority() {
+					return this._priority || 1;
+				}
+				async build() {
+					//const model = await this.model();
+					//if (!model) return;
+					log.info("Sanitizing the package.json...");
+					const packageJson = JSON.parse(await readFile(join(this.task.dest, "package.json"), "utf-8"));
+					let modified = false;
+					if (packageJson.workspaces) {
+						delete packageJson.workspaces;
+						modified = true;
+					}
+					if (packageJson.devDependencies) {
+						packageJson.devDependencies = Object.entries(packageJson.devDependencies).reduce((acc, [dep, version]) => {
+							if (valid(version) && dep !== "cds-plugin-ui5") {
+								acc[dep] = version;
+							}
+							return acc;
+						}, {});
+						modified = true;
+					}
+					if (modified) {
+						await writeFile(join(this.task.dest, "package.json"), JSON.stringify(packageJson, null, 2), "utf-8");
+					}
+					if (existsSync(join(this.task.dest, "package-lock.json"))) {
+						log.info("Updating the package-lock.json...");
+						try {
+							/* const { stdout, stderr } = */ await exec("npm install --package-lock-only", { cwd: this.task.dest });
+						} catch (e) {
+							//console.error(e.code);
+						}
+					}
+				}
+			}
+		);
+	} else {
+		log.info("The cds build task requires @sap/cds-dk version >= 7.6.0! Skipping execution as your @sap/cds-dk version is too old...");
+	}
 }

package/lib/findUI5Modules.js

@@ -53,7 +53,7 @@ module.exports = async function findUI5Modules({ cwd, cds, skipLocalApps, skipDe
 	const localApps = new Set();
 	const appDirs = [];
 	if (!skipLocalApps) {
-		const appDir = path.join(cwd, cds.env?.folders?.app || "app");
+		const appDir = path.join(cwd, cds?.env?.folders?.app || "app");
 		if (fs.existsSync(appDir)) {
 			// is the UI5 app directly in the app directory?
 			if (!fs.existsSync(path.join(appDir, determineUI5Yaml(appDir)))) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -15,7 +15,8 @@
     "@ui5/project": "^3.9.0",
     "@ui5/server": "^3.1.5",
     "js-yaml": "^4.1.0",
-    "node-html-parser": "^6.1.12"
+    "node-html-parser": "^6.1.12",
+    "semver": "^7.3.5"
   },
   "devDependencies": {
     "@sap/cds": "^6.8.4",
@@ -25,5 +26,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "95156c55194afaf62f32e2caef743a4e3f71702c"
+  "gitHead": "7a1592cd7493d75c6e33a015ac8f3ec141383e44"
 }