@sap-ux/ui5-application-inquirer 0.6.2 → 0.6.4

package/dist/prompts/prompt-helpers.d.ts

@@ -34,4 +34,11 @@ export declare function isVersionIncluded(version: string, minVersion: string):
  * @returns the updated questions
  */
 export declare function hidePrompts(prompts: Record<promptNames, UI5ApplicationQuestion>, promptOptions?: UI5ApplicationPromptOptions, isCapProject?: boolean): UI5ApplicationQuestion[];
+/**
+ * @param targetPath the target directory path.
+ * @param appName the application directory name.
+ * @param validateFioriAppFolder if true, validates the target path as a Fiori App project.
+ * @returns true if validated for Fiori App Project and Project Folder, false if appName length is less than 2. Otherwise appropriate validation message.
+ */
+export declare function validateTargetFolder(targetPath: string, appName: string, validateFioriAppFolder?: boolean): Promise<string | boolean>;
 //# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/prompt-helpers.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hidePrompts = exports.isVersionIncluded = exports.defaultAppName = exports.appPathExists = void 0;
+exports.validateTargetFolder = exports.hidePrompts = exports.isVersionIncluded = exports.defaultAppName = exports.appPathExists = void 0;
 const ui5_info_1 = require("@sap-ux/ui5-info");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const semver_1 = require("semver");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const validators_1 = require("./validators");
 /**
  * Tests if a directory with the specified `appName` exists at the path specified by `targetPath`.
  *
@@ -82,4 +84,24 @@ function hidePrompts(prompts, promptOptions, isCapProject) {
     return questions;
 }
 exports.hidePrompts = hidePrompts;
+/**
+ * @param targetPath the target directory path.
+ * @param appName the application directory name.
+ * @param validateFioriAppFolder if true, validates the target path as a Fiori App project.
+ * @returns true if validated for Fiori App Project and Project Folder, false if appName length is less than 2. Otherwise appropriate validation message.
+ */
+async function validateTargetFolder(targetPath, appName, validateFioriAppFolder) {
+    if (validateFioriAppFolder === true) {
+        const isFioriValid = await (0, validators_1.validateFioriAppProjectFolder)(targetPath);
+        if (isFioriValid !== true) {
+            return isFioriValid;
+        }
+    }
+    const isProjectValid = (0, project_input_validator_1.validateProjectFolder)(targetPath, appName);
+    if (isProjectValid !== true) {
+        return isProjectValid;
+    }
+    return true;
+}
+exports.validateTargetFolder = validateTargetFolder;
 //# sourceMappingURL=prompt-helpers.js.map

package/dist/prompts/prompts.js

@@ -32,7 +32,7 @@ function getQuestions(ui5Versions, promptOptions, capCdsInfo, isYUI = false) {
         [types_1.promptNames.title]: getTitlePrompt(),
         [types_1.promptNames.namespace]: getNamespacePrompt(appName),
         [types_1.promptNames.description]: getDescriptionPrompt(),
-        [types_1.promptNames.targetFolder]: getTargetFolderPrompt(targetDir),
+        [types_1.promptNames.targetFolder]: getTargetFolderPrompt(targetDir, promptOptions?.[types_1.promptNames.targetFolder]?.validateFioriAppFolder),
         [types_1.promptNames.ui5Version]: getUI5VersionPrompt(ui5Versions, promptOptions?.ui5Version),
         [types_1.promptNames.addDeployConfig]: getAddDeployConfigPrompt(targetDir, promptOptions?.addDeployConfig, isCapProject),
         [types_1.promptNames.addFlpConfig]: getAddFlpConfigPrompt(promptOptions?.addFlpConfig),
@@ -284,9 +284,10 @@ function getUI5VersionPrompt(ui5Versions = [], ui5VersionPromptOptions) {
  * Gets the `targetFolder` prompt.
  *
  * @param targetDir provides a default value for the target folder path
+ * @param validateFioriAppFolder validates the target folder path as a Fiori app project
  * @returns the `targetFolder` prompt
  */
-function getTargetFolderPrompt(targetDir) {
+function getTargetFolderPrompt(targetDir, validateFioriAppFolder) {
     return {
         type: 'input',
         name: types_1.promptNames.targetFolder,
@@ -298,9 +299,9 @@ function getTargetFolderPrompt(targetDir) {
             breadcrumb: (0, i18n_1.t)('prompts.appFolderPathBreadcrumb')
         },
         default: (answers) => answers.targetFolder || targetDir,
-        validate: (target, { name = '' }) => {
+        validate: async (target, { name = '' }) => {
             if (name.length > 2) {
-                return (0, project_input_validator_1.validateProjectFolder)(target, name);
+                return await (0, prompt_helpers_1.validateTargetFolder)(target, name, validateFioriAppFolder);
             }
             return false;
         }

package/dist/prompts/validators.d.ts

@@ -7,4 +7,11 @@
  * @returns true, if valid, or a string message indicating the reason why the input is invalid
  */
 export declare function validateAppName(appName: string, targetDir: string): boolean | string;
+/**
+ * Returns true if the specified target path does not contain a Fiori project.
+ *
+ * @param targetDir the target directory path.
+ * @returns true, if not Fiori Project, or string message indicating that the path contains a Fiori project.
+ */
+export declare function validateFioriAppProjectFolder(targetDir: string): Promise<string | boolean>;
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/validators.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAppName = void 0;
+exports.validateFioriAppProjectFolder = exports.validateAppName = void 0;
 const project_input_validator_1 = require("@sap-ux/project-input-validator");
 const prompt_helpers_1 = require("./prompt-helpers");
 const i18n_1 = require("../i18n");
+const project_access_1 = require("@sap-ux/project-access");
 /**
  * Returns true (valid) if the specified projectName is a valid module name
  * and if an application folder (directory) at the specified path does not exist.
@@ -24,4 +25,20 @@ function validateAppName(appName, targetDir) {
     return true;
 }
 exports.validateAppName = validateAppName;
+/**
+ * Returns true if the specified target path does not contain a Fiori project.
+ *
+ * @param targetDir the target directory path.
+ * @returns true, if not Fiori Project, or string message indicating that the path contains a Fiori project.
+ */
+async function validateFioriAppProjectFolder(targetDir) {
+    const appRoot = await (0, project_access_1.findRootsForPath)(targetDir);
+    if (appRoot) {
+        return (0, i18n_1.t)('validators.folderContainsFioriApp', { path: appRoot.appRoot });
+    }
+    else {
+        return true;
+    }
+}
+exports.validateFioriAppProjectFolder = validateFioriAppProjectFolder;
 //# sourceMappingURL=validators.js.map

package/dist/translations/ui5-application-inquirer.i18n.json

@@ -35,7 +35,8 @@
         "appShowAdvancedOptionsHint": "Choosing 'No' will apply defaults"
     },
     "validators": {
-        "appFolderExistsAtPath": "A module with this name already exists in the folder: {{-path}}"
+        "appFolderExistsAtPath": "A module with this name already exists in the folder: {{-path}}",
+        "folderContainsFioriApp": "The project folder path already contains an SAP Fiori application in the folder: {{-path}}. Please choose a different folder and try again."
     },
     "ui5VersionLabels": {
         "maintained": "Maintained",

package/dist/types.d.ts

@@ -97,6 +97,19 @@ type TargetFolderPromptOptions = {
      * Note that if a `default` option is also provided then this will be used instead of the `defaultValue` option.
      */
     defaultValue?: string;
+    /**
+     * If set to `true`, the target folder prompt's validator will perform additional validation to
+     * determine if the specified target path is contained in an existing Fiori application project path, which is invalid.
+     *
+     * **Behavior**:
+     * - **CAP Projects**: Validates if the target folder is part of a CAP project with a supported Fiori app.
+     * - **Non-CAP Projects**: Checks for recognised SAP Fiori apps, such as Fiori elements or SAPUI5
+     *   freestyle apps that have the correct structure and required dependencies.
+     * - **Validation Outcome**: Returns a validation message if the target folder meets the Fiori app criteria.
+     *
+     * If `false` or not provided, only ui5 project validation is performed without specific Fiori app checks.
+     */
+    validateFioriAppFolder?: boolean;
 };
 type NamePromptOptions = {
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-application-inquirer",
   "description": "Prompts module that can prompt users for inputs required for UI5 application writing",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,7 +24,7 @@
     "lodash": "4.17.21",
     "semver": "7.5.4",
     "@sap-ux/inquirer-common": "0.4.6",
-    "@sap-ux/project-access": "1.27.0",
+    "@sap-ux/project-access": "1.27.2",
     "@sap-ux/project-input-validator": "0.3.3",
     "@sap-ux/ui5-info": "0.8.1"
   },
@@ -35,7 +35,7 @@
     "@types/lodash": "4.14.202",
     "@types/semver": "7.5.4",
     "inquirer": "8.2.6",
-    "@sap-ux/cap-config-writer": "0.7.33"
+    "@sap-ux/cap-config-writer": "0.7.39"
   },
   "engines": {
     "node": ">=18.x"