@sap-ux/project-input-validator 0.1.2 → 0.2.0

package/dist/{validators.d.ts → deploy/validators.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Validator Fiori app name is compatbiel with Fiori project requirements.
+ * Validator Fiori app name is compatble with Fiori project requirements.
  *
  * @param name Fiori app name
  * @param prefix Prefix required by backend system
@@ -13,13 +13,6 @@ export declare function validateAppName(name: string, prefix?: string): boolean
  * @returns true or error message
  */
 export declare function validateAppDescription(description: string): boolean | string;
-/**
- * Client number is either empty or 3 digit string.
- *
- * @param client ABAP system client number
- * @returns true or error message
- */
-export declare function validateClient(client: string): boolean | string;
 /**
  * Transport request number is not required for local package.
  *
@@ -35,11 +28,4 @@ export declare function validateTransportRequestNumber(transportRequest: string,
  * @returns true or error message
  */
 export declare function validatePackage(input: string): boolean | string;
-/**
- * Validate url input is valid url format.
- *
- * @param input Backend ABAP system url
- * @returns true or error message
- */
-export declare function validateUrl(input: string): boolean | string;
 //# sourceMappingURL=validators.d.ts.map

package/dist/{validators.js → deploy/validators.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateUrl = exports.validatePackage = exports.validateTransportRequestNumber = exports.validateClient = exports.validateAppDescription = exports.validateAppName = void 0;
-const i18n_1 = require("./i18n");
+exports.validatePackage = exports.validateTransportRequestNumber = exports.validateAppDescription = exports.validateAppName = void 0;
+const i18n_1 = require("../i18n");
 const os_1 = require("os");
 /**
- * Validator Fiori app name is compatbiel with Fiori project requirements.
+ * Validator Fiori app name is compatble with Fiori project requirements.
  *
  * @param name Fiori app name
  * @param prefix Prefix required by backend system
@@ -14,20 +14,20 @@ function validateAppName(name, prefix) {
     const errorMessages = [];
     const length = name ? name.trim().length : 0;
     if (!length) {
-        return (0, i18n_1.t)('AbapAppNameRequired');
+        return (0, i18n_1.t)('deploy.abapAppNameRequired');
     }
     if (name.split('/').length > 3) {
-        errorMessages.push((0, i18n_1.t)('AbapInvalidNamespace'));
+        errorMessages.push((0, i18n_1.t)('deploy.abapInvalidNamespace'));
     }
     else if (/^\/.*\/\w*$/g.test(name)) {
         const splitNames = name.split('/');
         let accumulatedMsg = '';
         if (splitNames[1].length > 10) {
-            const errMsg = (0, i18n_1.t)('AbapInvalidNamespaceLength', { length: splitNames[1].length });
+            const errMsg = (0, i18n_1.t)('deploy.abapInvalidNamespaceLength', { length: splitNames[1].length });
             accumulatedMsg += `${errMsg}, `;
         }
         if (splitNames[2].length > 15) {
-            const errMsg = (0, i18n_1.t)('AbapInvalidAppNameLength', { length: splitNames[2].length });
+            const errMsg = (0, i18n_1.t)('deploy.abapInvalidAppNameLength', { length: splitNames[2].length });
             accumulatedMsg += `${errMsg}, `;
         }
         if (accumulatedMsg) {
@@ -36,13 +36,13 @@ function validateAppName(name, prefix) {
         }
     }
     else if (length > 15) {
-        errorMessages.push((0, i18n_1.t)('AbapInvalidAppNameLength', { length }));
+        errorMessages.push((0, i18n_1.t)('deploy.abapInvalidAppNameLength', { length }));
     }
     if (prefix && !name.toUpperCase().startsWith(prefix.toUpperCase())) {
-        errorMessages.push((0, i18n_1.t)('AbapInvalidAppName', { prefix }));
+        errorMessages.push((0, i18n_1.t)('deploy.abapInvalidAppName', { prefix }));
     }
     if (!/^[A-Za-z0-9_/]*$/.test(name)) {
-        errorMessages.push((0, i18n_1.t)('CharactersForbiddenInAppName'));
+        errorMessages.push((0, i18n_1.t)('deploy.charactersForbiddenInAppName'));
     }
     return processErrorMessages(errorMessages);
 }
@@ -61,7 +61,7 @@ function processErrorMessages(errorMessages) {
         return errorMessages[0];
     }
     else {
-        return `${(0, i18n_1.t)('InvalidAppNameMultipleReason')}${os_1.EOL}${errorMessages.join(os_1.EOL)}${os_1.EOL}`;
+        return `${(0, i18n_1.t)('deploy.invalidAppNameMultipleReason')}${os_1.EOL}${errorMessages.join(os_1.EOL)}${os_1.EOL}`;
     }
 }
 /**
@@ -72,30 +72,13 @@ function processErrorMessages(errorMessages) {
  */
 function validateAppDescription(description) {
     if (description.length > 60) {
-        return (0, i18n_1.t)('AbapAppDescLength');
+        return (0, i18n_1.t)('deploy.abapAppDescLength');
     }
     else {
         return true;
     }
 }
 exports.validateAppDescription = validateAppDescription;
-/**
- * Client number is either empty or 3 digit string.
- *
- * @param client ABAP system client number
- * @returns true or error message
- */
-function validateClient(client) {
-    const formattedInput = (client === null || client === void 0 ? void 0 : client.trim()) || '';
-    const isValid = formattedInput === '' || /^\d{3}$/.test(formattedInput);
-    if (isValid) {
-        return true;
-    }
-    else {
-        return (0, i18n_1.t)('InvalidClient', { client });
-    }
-}
-exports.validateClient = validateClient;
 /**
  * Transport request number is not required for local package.
  *
@@ -106,7 +89,7 @@ exports.validateClient = validateClient;
 function validateTransportRequestNumber(transportRequest, packageName) {
     const regex = /^[$LlTt]/;
     if (!regex.test(packageName) && !(transportRequest === null || transportRequest === void 0 ? void 0 : transportRequest.trim())) {
-        return (0, i18n_1.t)('AbapTransportNumRequired');
+        return (0, i18n_1.t)('deploy.abapTransportNumRequired');
     }
     else {
         return true;
@@ -121,27 +104,11 @@ exports.validateTransportRequestNumber = validateTransportRequestNumber;
  */
 function validatePackage(input) {
     if (!(input === null || input === void 0 ? void 0 : input.trim())) {
-        return (0, i18n_1.t)('AbapPackageWarn');
+        return (0, i18n_1.t)('deploy.abapPackageWarn');
     }
     else {
         return true;
     }
 }
 exports.validatePackage = validatePackage;
-/**
- * Validate url input is valid url format.
- *
- * @param input Backend ABAP system url
- * @returns true or error message
- */
-function validateUrl(input) {
-    try {
-        const url = new URL(input);
-        return !!url.protocol && !!url.host;
-    }
-    catch (_a) {
-        return (0, i18n_1.t)('InvalidUrl', { input });
-    }
-}
-exports.validateUrl = validateUrl;
 //# sourceMappingURL=validators.js.map

package/dist/general/validators.d.ts

@@ -0,0 +1,15 @@
+/**
+ * SAP client number is either empty or 3 digit string.
+ *
+ * @param client ABAP system client number
+ * @returns true or error message
+ */
+export declare function validateClient(client: string): boolean | string;
+/**
+ * Validate url input is valid url format.
+ *
+ * @param input Backend ABAP system url
+ * @returns true or error message
+ */
+export declare function validateUrl(input: string): boolean | string;
+//# sourceMappingURL=validators.d.ts.map

package/dist/general/validators.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUrl = exports.validateClient = void 0;
+const i18n_1 = require("../i18n");
+/**
+ * SAP client number is either empty or 3 digit string.
+ *
+ * @param client ABAP system client number
+ * @returns true or error message
+ */
+function validateClient(client) {
+    const formattedInput = (client === null || client === void 0 ? void 0 : client.trim()) || '';
+    const isValid = formattedInput === '' || /^\d{3}$/.test(formattedInput);
+    if (isValid) {
+        return true;
+    }
+    else {
+        return (0, i18n_1.t)('general.invalidClient', { client });
+    }
+}
+exports.validateClient = validateClient;
+/**
+ * Validate url input is valid url format.
+ *
+ * @param input Backend ABAP system url
+ * @returns true or error message
+ */
+function validateUrl(input) {
+    try {
+        const url = new URL(input);
+        return !!url.protocol && !!url.host;
+    }
+    catch (_a) {
+        return (0, i18n_1.t)('general.invalidUrl', { input });
+    }
+}
+exports.validateUrl = validateUrl;
+//# sourceMappingURL=validators.js.map

package/dist/i18n.d.ts

@@ -5,7 +5,7 @@ export declare const PROJECT_INPUT_VALIDATOR_NS = "project-input-validator";
  */
 export declare function initI18n(): Promise<void>;
 /**
- * Helper function facading the call to i18next.
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *
  * @param key i18n key
  * @param options additional options

package/dist/i18n.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.t = exports.initI18n = exports.PROJECT_INPUT_VALIDATOR_NS = void 0;
 const i18next_1 = __importDefault(require("i18next"));
-const common_i18n_json_1 = __importDefault(require("./translations/common.i18n.json"));
+const project_input_validator_i18n_json_1 = __importDefault(require("./translations/project-input-validator.i18n.json"));
 exports.PROJECT_INPUT_VALIDATOR_NS = 'project-input-validator';
 /**
  * Initialize i18next with the translations for this module.
@@ -24,7 +24,7 @@ function initI18n() {
         yield i18next_1.default.init({
             resources: {
                 en: {
-                    [exports.PROJECT_INPUT_VALIDATOR_NS]: common_i18n_json_1.default
+                    [exports.PROJECT_INPUT_VALIDATOR_NS]: project_input_validator_i18n_json_1.default
                 }
             },
             lng: 'en',
@@ -36,17 +36,20 @@ function initI18n() {
 }
 exports.initI18n = initI18n;
 /**
- * Helper function facading the call to i18next.
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *
  * @param key i18n key
  * @param options additional options
  * @returns {string} localized string stored for the given key
  */
 function t(key, options) {
+    if (!(options === null || options === void 0 ? void 0 : options.ns)) {
+        options = Object.assign(options !== null && options !== void 0 ? options : {}, { ns: exports.PROJECT_INPUT_VALIDATOR_NS });
+    }
     return i18next_1.default.t(key, options);
 }
 exports.t = t;
 initI18n().catch(() => {
-    // Ignore any errors since the write will still work
+    // needed by lint
 });
 //# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export * from './validators';
+export * from './deploy/validators';
+export * from './ui5/validators';
+export * from './general/validators';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,5 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./validators"), exports);
+__exportStar(require("./deploy/validators"), exports);
+__exportStar(require("./ui5/validators"), exports);
+__exportStar(require("./general/validators"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,49 @@
+{
+    "deploy": {
+        "a": "Deployment Description should not exceed 60 characters",
+        "abapTransportNumRequired": "Provide a transport request for your application",
+        "abapPackageWarn": "Provide a package",
+        "abapAppNameRequired": "Application name required",
+        "abapInvalidNamespace": "Namespace invalid as there are too many forward slashes",
+        "abapInvalidNamespaceLength": "Namespace limited to 10 characters, entered {{length}}",
+        "abapInvalidAppNameLength": "Application name limited to 15 characters, entered {{length}}",
+        "abapInvalidAppName": "Application name needs to be prefixed with [{{prefix}}]",
+        "charactersForbiddenInAppName": "Only alphanumeric, underscore and slash characters are allowed",
+        "invalidAppNameMultipleReason": "Application name is invalid for multiple reasons:"
+    },
+    "ui5": {
+        "namespaceMustStartWithLetter": "The namespace must start with a letter",
+        "namespaceEndInPeriod": "The namespace cannot end with a period",
+        "namespaceCannotBeSap": "The namespace cannot be {{str}}",
+        "namespaceStartsWithNew": "The namespace cannot start with {{str}}",
+        "namespaceNumberAfterPeriod": "A number cannot follow a period in the namespace",
+        "lowerAlphaNumericOnly": "Please use lowercase alpha numeric characters only",
+        "lowerAlphaNumericDotsOnly": "Please use lowercase alpha numeric characters and dots only for the namespace.",
+        "namespaceSpecialCharacter": "The namespace can only contain letters, digits, dots, and underscores",
+        "moduleNameMustStartWithLetter": "The module name must start with a letter",
+        "nameCombinedTooLong": "The combined length of the namespace and module name must not exceed {{length}} characters",
+        "folderDoesNotExist": "Folder does not exist. Please enter the root folder for your project",
+        "folderDoesNotHaveCorrectPermissions": "Selected folder does not have required permissions. Please ensure you have permission to write to the selected folder and try again.",
+        "enterProjectFolder": "Please enter a project folder",
+        "nameNull": "Module name cannot be null",
+        "nameUndefined": "Module name cannot be undefined",
+        "nameNotString": "Module name must be a string",
+        "nameLengthZero": "Module name's length must be greater than zero",
+        "nameStartsWithPeriod": "Module name cannot start with a period",
+        "nameStartsWithUnderscore": "Module name cannot start with an underscore",
+        "nameStartsOrEndsWithSpace": "Module name cannot contain leading or trailing spaces",
+        "nameBlocklisted": "{{modName}} is a blocklisted module name",
+        "nameIsCoreModule": "{{modName}} is a core module name",
+        "nameTooLong": "Module name cannot contain more than {{length}} characters",
+        "nameTooShort": "Module name must be at least {{length}} characters",
+        "inputValueContainsCapital": "{{promptName}} cannot contain capital letters",
+        "nameContainsSpecialCharacters": "Module name cannot contain special characters (\"~'!()*)",
+        "nameNotUrlFriendly": "Module name can only contain URL-friendly characters",
+        "invalidModuleName": "Invalid module name",
+        "moduleAlreadyExists": "The folder: {{folderName}} already exists at the specified path"
+    },
+    "general": {
+        "invalidUrl": "Invalid URL: [{{-input}}]",
+        "invalidClient": "[{{client}}] is invalid. Enter blank or a value between 000-999"
+    }
+}

package/dist/ui5/validators.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Validator: UI5 namespace.
+ *
+ * @param namespace - namepsace to validate
+ * @param moduleName - module name
+ * @param allowUnderscore - is underscore characters allowed
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+export declare function validateNamespace(namespace: string, moduleName?: string, allowUnderscore?: boolean): boolean | string;
+/**
+ * Validator: UI5 library module name.
+ *
+ * @param libName - library module name
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+export declare function validateLibModuleName(libName: string): boolean | string;
+/**
+ * Validator: UI5 project directory can be used to create a UI5 application.
+ *
+ * @param targetFolder - the directory path not including the application folder (UI5 application name)
+ * @param projectName - the UI5 application directory name
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation function
+ */
+export declare function validateProjectFolder(targetFolder: string, projectName: string): boolean | string;
+/**
+ * Validator: UI5 package json module name validator. Validates a module name accoding to npm package rules and some additional UI5 specific rules.
+ *
+ * @param moduleName - module name to validate
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+export declare function validateModuleName(moduleName: string): boolean | string;
+//# sourceMappingURL=validators.d.ts.map

package/dist/ui5/validators.js

@@ -0,0 +1,182 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateModuleName = exports.validateProjectFolder = exports.validateLibModuleName = exports.validateNamespace = void 0;
+const path_1 = require("path");
+const i18n_1 = require("../i18n");
+const fs_1 = require("fs");
+const validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
+/**
+ * Validator: UI5 application namespace.
+ *
+ * @param namespace - namespace
+ * @param moduleName - module name
+ * @param allowUnderscore - should allow underscores in namespace
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+function validateNamespacePattern(namespace, moduleName = '', allowUnderscore = true) {
+    // Since namespace is concatenated with name to write the app id to the yamls we must comply with the yaml specVersion validation
+    // https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name
+    if (!/^[a-zA-Z]/.test(namespace)) {
+        return (0, i18n_1.t)('ui5.namespaceMustStartWithLetter');
+    }
+    if (namespace.endsWith('.')) {
+        return (0, i18n_1.t)('ui5.namespaceEndInPeriod');
+    }
+    if (namespace.toUpperCase() === 'SAP') {
+        return (0, i18n_1.t)('ui5.namespaceCannotBeSap', { str: namespace });
+    }
+    if (namespace.toLowerCase().startsWith('new')) {
+        return (0, i18n_1.t)('ui5.namespaceStartsWithNew', { str: namespace.substring(0, 3) });
+    }
+    if (/\.\d/.test(namespace)) {
+        return (0, i18n_1.t)('ui5.namespaceNumberAfterPeriod');
+    }
+    if (allowUnderscore && !/^[\w.]+$/.test(namespace)) {
+        return (0, i18n_1.t)('ui5.namespaceSpecialCharacter');
+    }
+    else if (!allowUnderscore && !/^[a-z0-9.]*$/g.test(namespace)) {
+        return (0, i18n_1.t)('ui5.lowerAlphaNumericDotsOnly');
+    }
+    if ((moduleName + namespace).length > 70) {
+        return (0, i18n_1.t)('ui5.nameCombinedTooLong', { length: 70 });
+    }
+    if (namespace.toLowerCase() !== namespace) {
+        return (0, i18n_1.t)('ui5.inputValueContainsCapital', { promptName: 'Namespace' });
+    }
+    return true;
+}
+/**
+ * Validator: UI5 namespace.
+ *
+ * @param namespace - namepsace to validate
+ * @param moduleName - module name
+ * @param allowUnderscore - is underscore characters allowed
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+function validateNamespace(namespace, moduleName, allowUnderscore = true) {
+    if (!namespace) {
+        return false;
+    }
+    return validateNamespacePattern(namespace, moduleName, allowUnderscore);
+}
+exports.validateNamespace = validateNamespace;
+/**
+ * Validator: UI5 library module name.
+ *
+ * @param libName - library module name
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+function validateLibModuleName(libName) {
+    const isValid = validateModuleName(libName);
+    if (typeof isValid === 'string') {
+        return isValid;
+    }
+    if (!/^[a-z0-9]*$/g.test(libName)) {
+        return (0, i18n_1.t)('ui5.lowerAlphaNumericOnly');
+    }
+    return true;
+}
+exports.validateLibModuleName = validateLibModuleName;
+/**
+ * Validator: UI5 project directory can be used to create a UI5 application.
+ *
+ * @param targetFolder - the directory path not including the application folder (UI5 application name)
+ * @param projectName - the UI5 application directory name
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation function
+ */
+function validateProjectFolder(targetFolder, projectName) {
+    if (!folderExists(targetFolder)) {
+        return (0, i18n_1.t)('ui5.folderDoesNotExist');
+    }
+    if (!folderWritePermExists(targetFolder)) {
+        return (0, i18n_1.t)('ui5.folderDoesNotHaveCorrectPermissions');
+    }
+    if (targetFolder && targetFolder.length > 0 && !folderExists((0, path_1.join)(targetFolder, projectName))) {
+        return true;
+    }
+    else if (targetFolder && targetFolder.length > 0 && folderExists((0, path_1.join)(targetFolder, projectName))) {
+        return (0, i18n_1.t)('ui5.moduleAlreadyExists', { folderName: projectName });
+    }
+    else {
+        return (0, i18n_1.t)('ui5.enterProjectFolder');
+    }
+}
+exports.validateProjectFolder = validateProjectFolder;
+/**
+ * Validator: UI5 package json module name validator. Validates a module name accoding to npm package rules and some additional UI5 specific rules.
+ *
+ * @param moduleName - module name to validate
+ * @returns true if valid, otherwise an error message string for use in Inquirer validation functions
+ */
+function validateModuleName(moduleName) {
+    var _a, _b;
+    if (/^[^a-zA-Z]/.test(moduleName)) {
+        return (0, i18n_1.t)('ui5.moduleNameMustStartWithLetter');
+    }
+    if ((moduleName === null || moduleName === void 0 ? void 0 : moduleName.length) > 70) {
+        return (0, i18n_1.t)('ui5.nameTooLong', { length: 70 });
+    }
+    if ((moduleName === null || moduleName === void 0 ? void 0 : moduleName.length) < 3) {
+        return (0, i18n_1.t)('ui5.nameTooShort', { length: 3 });
+    }
+    // convert the validation strings from `validateNpmPackageName` to required texts
+    const messageMap = {
+        'name cannot be null': (0, i18n_1.t)('ui5.nameNull'),
+        'name cannot be undefined': (0, i18n_1.t)('ui5.nameUndefined'),
+        'name must be a string': (0, i18n_1.t)('ui5.nameNotString'),
+        'name length must be greater than zero': (0, i18n_1.t)('ui5.nameLengthZero'),
+        'name cannot start with a period': (0, i18n_1.t)('ui5.nameStartsWithPeriod'),
+        'name cannot start with an underscore': (0, i18n_1.t)('ui5.nameStartsWithUnderscore'),
+        'name cannot contain leading or trailing spaces': (0, i18n_1.t)('ui5.nameStartsOrEndsWithSpace'),
+        [moduleName + ' is a blocklisted name']: (0, i18n_1.t)('ui5.nameBlocklisted', { moduleName }),
+        [moduleName + ' is a core module name']: (0, i18n_1.t)('ui5.nameIsCoreModule', { moduleName }),
+        'name can no longer contain more than 214 characters': (0, i18n_1.t)('ui5.nameTooLong', { length: 214 }),
+        'name can no longer contain capital letters': (0, i18n_1.t)('ui5.INPUT_VALUE_CONTAINS_CAPITAL', {
+            promptName: 'Module'
+        }),
+        'name can no longer contain special characters ("~\'!()*")': (0, i18n_1.t)('ui5.NAME_CONTAINS_SPECIAL_CHARACTERS'),
+        'name can only contain URL-friendly characters': (0, i18n_1.t)('ui5.NAME_NOT_URL_FRIENDLY')
+    };
+    const valid = (0, validate_npm_package_name_1.default)(moduleName);
+    if (valid.validForNewPackages && valid.validForOldPackages) {
+        return true;
+    }
+    return [...((_a = valid.errors) !== null && _a !== void 0 ? _a : []), ...((_b = valid.warnings) !== null && _b !== void 0 ? _b : [])]
+        .filter((msg) => !!msg)
+        .map((msg) => { var _a; return (_a = messageMap[msg]) !== null && _a !== void 0 ? _a : (0, i18n_1.t)('ui5.invalidModuleName'); })
+        .join(', ');
+}
+exports.validateModuleName = validateModuleName;
+/**
+ * Test for existence of specified directory path.
+ *
+ * @param dirPath - directory path
+ * @returns true if the directory exists, false if not or validation error message
+ */
+function folderExists(dirPath) {
+    if (dirPath && typeof dirPath !== 'string') {
+        return (0, i18n_1.t)('ERROR_NAME_NOT_STRING');
+    }
+    return (0, fs_1.existsSync)(dirPath) && (0, fs_1.lstatSync)(dirPath).isDirectory();
+}
+/**
+ * Test for directory write permissions.
+ *
+ * @param dirPath - path to the directory to test
+ * @returns true, if write is allowed
+ */
+function folderWritePermExists(dirPath) {
+    let folderPerm = true;
+    const isWin = process.platform === 'win32';
+    try {
+        (0, fs_1.accessSync)(isWin ? path_1.posix.basename(dirPath) : dirPath, fs_1.constants.W_OK);
+    }
+    catch (err) {
+        folderPerm = false;
+    }
+    return folderPerm;
+}
+//# sourceMappingURL=validators.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-input-validator",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Library to validate Fiori project input formats",
   "repository": {
     "type": "git",
@@ -14,9 +14,14 @@
   "private": false,
   "main": "dist/index.js",
   "dependencies": {
-    "i18next": "20.6.1"
+    "i18next": "20.6.1",
+    "validate-npm-package-name": "5.0.0"
+  },
+  "devDependencies": {
+    "@types/validate-npm-package-name": "4.0.1",
+    "@types/i18next": "13.0.0",
+    "jest-extended": "3.2.4"
   },
-  "devDependencies": {},
   "files": [
     "dist",
     "LICENSE",
@@ -25,7 +30,7 @@
   ],
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
-    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+    "node": ">=18.x"
   },
   "scripts": {
     "build": "tsc --build",

package/dist/translations/common.i18n.json

@@ -1,14 +0,0 @@
-{
-    "AbapAppDescLength": "Deployment Description should not exceed 60 characters",
-    "InvalidClient": "[{{client}}] is invalid. Enter blank or a value between 000-999",
-    "AbapTransportNumRequired": "Provide a transport request for your application",
-    "AbapPackageWarn": "Provide a package",
-    "InvalidUrl": "Invalid URL: [{{input}}]",
-    "AbapAppNameRequired": "Application name required",
-    "AbapInvalidNamespace": "Namespace invalid as there are too many forward slashes",
-    "AbapInvalidNamespaceLength": "Namespace limited to 10 characters, entered {{length}}",
-    "AbapInvalidAppNameLength": "Application name limited to 15 characters, entered {{length}}",
-    "AbapInvalidAppName": "Application name needs to be prefixed with [{{prefix}}]",
-    "CharactersForbiddenInAppName": "Only alphanumeric, underscore and slash characters are allowed",
-    "InvalidAppNameMultipleReason": "Application name is invalid for multiple reasons:"
-}