@sap-ux/project-input-validator 0.3.4 → 0.5.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './deploy/validators';
 export * from './ui5/validators';
+export * from './ui5/project-path-validators';
 export * from './general/validators';
 export * from './adp/validators';
 export * from './flp/validators';

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addi18nResourceBundle = void 0;
 __exportStar(require("./deploy/validators"), exports);
 __exportStar(require("./ui5/validators"), exports);
+__exportStar(require("./ui5/project-path-validators"), exports);
 __exportStar(require("./general/validators"), exports);
 __exportStar(require("./adp/validators"), exports);
 __exportStar(require("./flp/validators"), exports);

package/dist/translations/project-input-validator.i18n.json

@@ -40,7 +40,10 @@
         "nameContainsSpecialCharacters": "Module name cannot contain special characters (\"~'!()*)",
         "nameNotUrlFriendly": "Module name can only contain URL-friendly characters",
         "invalidModuleName": "Invalid module name",
-        "moduleAlreadyExists": "The module folder named: {{folderName}} already exists at the specified path"
+        "moduleAlreadyExists": "The module folder named: {{folderName}} already exists at the specified 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.",
+        "folderContainsCapApp": "The selected project folder is part of an existing CAP project. This application must therefore use the local CAP project as the data source."
     },
     "general": {
         "invalidUrl": "Invalid URL: [{{-input}}]",

package/dist/ui5/project-path-validators.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Validates whether the specified target path is suitable for creating a Fiori App project.
+ * The function performs the following checks:
+ *
+ * 1. **CAP Project Check:** If `validateFioriAppFolder` is true, it checks if the target path is part of an existing CAP project.
+ *    - Uses `findCapProjectRoot()` and `getCapProjectType()` to verify the presence of a CAP project.
+ *    - Returns an error message if a CAP project is detected.
+ *
+ * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains a Fiori project.
+ *    - Uses `findRootsForPath()` to determine if a Fiori application root exists.
+ *    - Returns a success message if a valid Fiori app root is found, otherwise returns true.
+ *
+ * 3. **General Project Folder Check:**
+ *    - Uses `validateProjectFolder()` to verify if the provided target path exists.
+ *    - Ensures the target folder does not already contain a subfolder with the intended project name.
+ *
+ * @param targetPath - The target directory path where the Fiori app is to be created.
+ * @param appName - The application directory name.
+ * @param validateFioriAppFolder - If true, validates the target path as a Fiori App project folder.
+ * @returns A boolean value `true` if all validations pass; otherwise, an error message.
+ */
+export declare function validateFioriAppTargetFolder(targetPath: string, appName: string, validateFioriAppFolder?: boolean): Promise<string | boolean>;
+//# sourceMappingURL=project-path-validators.d.ts.map

package/dist/ui5/project-path-validators.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFioriAppTargetFolder = validateFioriAppTargetFolder;
+const project_access_1 = require("@sap-ux/project-access");
+const validators_1 = require("./validators");
+const i18n_1 = require("../i18n");
+/**
+ * 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) {
+    // Check if the target directory contains a CAP project
+    if (!!(await (0, project_access_1.findCapProjectRoot)(targetDir, false)) || !!(await (0, project_access_1.getCapProjectType)(targetDir))) {
+        return (0, i18n_1.t)('ui5.folderContainsCapApp');
+    }
+    // Check if the target directory contains a Fiori project
+    const appRoot = await (0, project_access_1.findRootsForPath)(targetDir);
+    if (appRoot) {
+        return (0, i18n_1.t)('ui5.folderContainsFioriApp', { path: appRoot.appRoot });
+    }
+    else {
+        return true;
+    }
+}
+/**
+ * Validates whether the specified target path is suitable for creating a Fiori App project.
+ * The function performs the following checks:
+ *
+ * 1. **CAP Project Check:** If `validateFioriAppFolder` is true, it checks if the target path is part of an existing CAP project.
+ *    - Uses `findCapProjectRoot()` and `getCapProjectType()` to verify the presence of a CAP project.
+ *    - Returns an error message if a CAP project is detected.
+ *
+ * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains a Fiori project.
+ *    - Uses `findRootsForPath()` to determine if a Fiori application root exists.
+ *    - Returns a success message if a valid Fiori app root is found, otherwise returns true.
+ *
+ * 3. **General Project Folder Check:**
+ *    - Uses `validateProjectFolder()` to verify if the provided target path exists.
+ *    - Ensures the target folder does not already contain a subfolder with the intended project name.
+ *
+ * @param targetPath - The target directory path where the Fiori app is to be created.
+ * @param appName - The application directory name.
+ * @param validateFioriAppFolder - If true, validates the target path as a Fiori App project folder.
+ * @returns A boolean value `true` if all validations pass; otherwise, an error message.
+ */
+async function validateFioriAppTargetFolder(targetPath, appName, validateFioriAppFolder) {
+    if (validateFioriAppFolder === true) {
+        const isFioriValid = await validateFioriAppProjectFolder(targetPath);
+        if (isFioriValid !== true) {
+            return isFioriValid;
+        }
+    }
+    const isProjectValid = (0, validators_1.validateProjectFolder)(targetPath, appName);
+    if (isProjectValid !== true) {
+        return isProjectValid;
+    }
+    return true;
+}
+//# sourceMappingURL=project-path-validators.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-input-validator",
-  "version": "0.3.4",
+  "version": "0.5.0",
   "description": "Library to validate Fiori project input formats",
   "repository": {
     "type": "git",
@@ -15,7 +15,8 @@
   "main": "dist/index.js",
   "dependencies": {
     "i18next": "23.5.1",
-    "validate-npm-package-name": "5.0.0"
+    "validate-npm-package-name": "5.0.0",
+    "@sap-ux/project-access": "1.29.18"
   },
   "devDependencies": {
     "@types/validate-npm-package-name": "4.0.1",