cds-plugin-ui5 0.6.1 → 0.6.3

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.6.3](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.2...cds-plugin-ui5@0.6.3) (2023-09-08)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** fix type for config ([ebd95f0](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/ebd95f0e5a269c769587e7c9c3bdf6885fc7ca3d))
+
+
+
+
+
+## [0.6.2](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.1...cds-plugin-ui5@0.6.2) (2023-09-08)
+
+
+### Bug Fixes
+
+* **cds-plugin-ui5:** allow relative config files in package.json ([#838](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/838)) ([735b24d](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/735b24d34cebee5463c97c3bb5a3d58e07dace24))
+
+
+
+
+
 ## [0.6.1](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.0...cds-plugin-ui5@0.6.1) (2023-09-08)
 
 

package/README.md

@@ -108,6 +108,8 @@ The available configuration options are:
 * `workspaceName`: *`string`* - name of the workspace (defaults to "default" when the file at workspaceConfigPath exists)
 * `versionOverride`: *`string`* - Framework version to use instead of the one defined in the root project
 
+If the `configFile` or `workspaceConfigFile` startes with `./` or `../` then the config file is considered to be relative to the `package.json`.
+
 The configuration can also be injected with the environment variable `CDS_PLUGIN_UI5_MODULES`. It contains the JSON string from the configuration above, e.g.:
 
 ```sh

package/cds-plugin.js

@@ -49,6 +49,7 @@ cds.on("bootstrap", async function bootstrap(app) {
 		// apply the UI5 middlewares to the router and
 		// retrieve the available HTML pages
 		const appInfo = await applyUI5Middleware(router, {
+			cwd,
 			basePath: modulePath,
 			...(config[moduleId] || {}),
 		});

package/lib/applyUI5Middleware.js

@@ -12,6 +12,7 @@ const log = require("./log");
 /**
  * @typedef applyUI5MiddlewareOptions
  * @type {object}
+ * @property {string} [cwd] cwd to resolve relative config files to, e.g. "./ui5.yaml" or "./ui5-workspace.yaml" (defaults to `process.cwd()`)
  * @property {string} [basePath] base path of the UI5 application (defaults to `process.cwd()`)
  * @property {string} [configFile] name of the config file (defaults to "ui5.yaml")
  * @property {string} [configPath] /!\ RESTRICTED /!\ - path to the ui5.yaml (defaults to "${basePath}/${configFile}")
@@ -30,23 +31,37 @@ const log = require("./log");
  * @param {applyUI5MiddlewareOptions} options configuration options
  * @returns {UI5AppInfo} UI5 application information object
  */
-module.exports = async function applyUI5Middleware(router, options = { basePath: process.cwd() }) {
+module.exports = async function applyUI5Middleware(router, options) {
 	const { graphFromPackageDependencies } = await import("@ui5/project/graph");
 	const { createReaderCollection } = await import("@ui5/fs/resourceFactory");
 
+	options.cwd = options.cwd || process.cwd();
+	options.basePath = options.basePath || process.cwd();
+
 	const configPath = options.configPath || options.basePath;
 	const configFile = options.configFile || "ui5.yaml";
 	const workspaceConfigPath = options.workspaceConfigPath || options.basePath;
-	const workpaceConfigFile = options.workpaceConfigFile || "ui5-workspace.yaml";
+	const workspaceConfigFile = options.workspaceConfigFile || "ui5-workspace.yaml";
 
 	const determineConfigPath = function (configPath, configFile) {
+		// ensure that the config path is absolute
+		if (!path.isAbsolute(configPath)) {
+			configPath = path.resolve(options.basePath, configPath);
+		}
+		// if the config path is a file, then we assume that this is the
+		// configuration which should be used for the UI5 server middlewares
 		if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
 			return configPath;
 		}
-		configPath = path.resolve(configPath, configFile);
+		// if the configuration file is starting with ./ or ../ then we
+		// resolve the configuration relative to the current working dir
+		// otherwise we are resolving it relative to the config path
+		// which is typically the directory of the UI5 application
+		configPath = path.resolve(/^\.\.?\//.test(configFile) ? options.cwd : configPath, configFile);
 		if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
 			return configPath;
 		}
+		// nothing matched => no config
 		return undefined;
 	};
 
@@ -54,7 +69,7 @@ module.exports = async function applyUI5Middleware(router, options = { basePath:
 		cwd: options.basePath,
 		rootConfigPath: determineConfigPath(configPath, configFile),
 		workspaceName: process.env["ui5-workspace"] || options.workspaceName || "default",
-		workspaceConfigPath: determineConfigPath(workspaceConfigPath, workpaceConfigFile),
+		workspaceConfigPath: determineConfigPath(workspaceConfigPath, workspaceConfigFile),
 		versionOverride: options.versionOverride,
 		cacheMode: options.cacheMode,
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "A CAP server cds-plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -24,5 +24,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "8a914d8872de9fd4b0583fe44493acf0cee71c86"
+  "gitHead": "3472cac3f95ef971a3b912fc71c97cd8e3518e20"
 }