@sap-ux/cap-config-writer 0.2.16 → 0.2.18

package/dist/cap-config/index.d.ts

@@ -1,5 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
 export { satisfiesMinCdsVersion } from './package-json';
+import type { CdsUi5PluginInfo } from './types';
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
  *
@@ -10,10 +11,20 @@ export { satisfiesMinCdsVersion } from './package-json';
 export declare function enableCdsUi5Plugin(basePath: string, fs?: Editor): Promise<Editor>;
 /**
  * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
+ * Overloaded function that returns detailed CAP plugin info.
  *
  * @param basePath - root path of the CAP project, where package.json is located
  * @param [fs] - optional: the memfs editor instance
  * @returns true: cds-plugin-ui5 and all prerequisites are fulfilled; false: cds-plugin-ui5 is not enabled or not all prerequisites are fulfilled
  */
 export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor): Promise<boolean>;
+/**
+ * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
+ *
+ * @param basePath - root path of the CAP project, where package.json is located
+ * @param [fs] - optional: the memfs editor instance
+ * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
+ * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
+ */
+export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor, moreInfo?: boolean): Promise<boolean | CdsUi5PluginInfo>;
 //# sourceMappingURL=index.d.ts.map

package/dist/cap-config/index.js

@@ -44,9 +44,11 @@ exports.enableCdsUi5Plugin = enableCdsUi5Plugin;
  *
  * @param basePath - root path of the CAP project, where package.json is located
  * @param [fs] - optional: the memfs editor instance
- * @returns true: cds-plugin-ui5 and all prerequisites are fulfilled; false: cds-plugin-ui5 is not enabled or not all prerequisites are fulfilled
+ * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
+ * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info or true if
+ * cds-plugin-ui5 and all prerequisites are fulfilled
  */
-function checkCdsUi5PluginEnabled(basePath, fs) {
+function checkCdsUi5PluginEnabled(basePath, fs, moreInfo = false) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -57,7 +59,14 @@ function checkCdsUi5PluginEnabled(basePath, fs) {
         }
         const packageJson = fs.readJSON(packageJsonPath);
         const { workspaceEnabled } = yield (0, package_json_1.getWorkspaceInfo)(basePath, packageJson);
-        return (0, package_json_1.hasMinCdsVersion)(packageJson) && workspaceEnabled && (0, package_json_1.hasCdsPluginUi5)(packageJson);
+        const cdsInfo = {
+            hasMinCdsVersion: (0, package_json_1.satisfiesMinCdsVersion)(packageJson),
+            isWorkspaceEnabled: workspaceEnabled,
+            hasCdsUi5Plugin: (0, package_json_1.hasCdsPluginUi5)(packageJson),
+            isCdsUi5PluginEnabled: false
+        };
+        cdsInfo.isCdsUi5PluginEnabled = cdsInfo.hasMinCdsVersion && cdsInfo.isWorkspaceEnabled && cdsInfo.hasCdsUi5Plugin;
+        return moreInfo ? cdsInfo : cdsInfo.isCdsUi5PluginEnabled;
     });
 }
 exports.checkCdsUi5PluginEnabled = checkCdsUi5PluginEnabled;

package/dist/cap-config/types.d.ts

@@ -0,0 +1,19 @@
+export type CdsUi5PluginInfo = {
+    /**
+     * Convienience property. The CDS UI5 plugin is considered enabled if `hasCdsUi5Plugin`, `hasMinCdsVersion`, `isWorkspaceEnabled` are all true.
+     */
+    isCdsUi5PluginEnabled: boolean;
+    /**
+     * True if the CDS version satisfies the minimum supported CDS version
+     */
+    hasMinCdsVersion: boolean;
+    /**
+     * True if NPM workspaces are enabled at the root of a CAP project
+     */
+    isWorkspaceEnabled: boolean;
+    /**
+     * True if the CDS ui5 plugin is specified as a dependency
+     */
+    hasCdsUi5Plugin: boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/cap-config/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';
+export type { CdsUi5PluginInfo } from './cap-config/types';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cap-config-writer",
   "description": "Add or update configuration for SAP CAP projects",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,11 +19,10 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "i18next": "20.6.1",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
-    "@sap-ux/project-access": "1.17.5"
+    "@sap-ux/project-access": "1.17.6"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",