@sap-ux/ui5-application-inquirer 0.2.0

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

@@ -0,0 +1,46 @@
+{
+    "prompts": {
+        "appNameTooltip": "The name of the module for this application that will be loaded at runtime. This also determines the directory name of the generated application.",
+        "appNameMessage": "Module name",
+        "appNameDefault": "project{{defaultProjectNumber}}",
+        "appTitleTooltip": "The title of your application that is displayed in the header of the application.",
+        "appTitleMessage": "Application title",
+        "appTitleDefault": "App Title",
+        "appNamespaceTooltip": "A unique package name for the application module being created. It should follow the standard Java package notation.",
+        "appNamespaceMessage": "Application namespace",
+        "appDescTooltip": "Project description in package.json of your project",
+        "appDescMessage": "Description",
+        "appDescDefault": "An SAP Fiori application.",
+        "appFolderPathMessage": "Project folder path",
+        "appFolderPathBreadcrumb": "Project Path",
+        "appUi5VersionTooltip": "Represents the minimum version of SAPUI5 that this application requires.",
+        "appUi5VersionMessage": "Minimum SAPUI5 version",
+        "appUi5VersionBreadcrumb": "UI5 Version",
+        "appAddDeployConfigMessage": "Add deployment configuration",
+        "appAddDeployConfigToMtaMessage": "Add deployment configuration to MTA project ({{-path}})",
+        "appAddDeployConfigBreadcrumb": "Deploy Config",
+        "appAddFlpConfigMessage": "Add FLP configuration",
+        "appAddFlpConfigBreadcrumb": "FLP Config",
+        "appUi5ThemeMessage": "UI5 theme",
+        "appEnableEslintMessage": "Add Eslint configuration to the project",
+        "appEnableEslintBreadcrumb": "Eslint",
+        "appEnableCodeAssistMessage": "Add code assist libraries to your project",
+        "appEnableCodeAssistBreadcrumb": "Code Assist",
+        "appSkipAnnotationsMessage": "Skip generation of associated annotations.cds file",
+        "appSkipAnnotationsBreadcrumb": "Skip Annotations",
+        "appEnableNpmWorkspacesMessage": "Generation of this application can update the CAP project to use NPM workspaces and an associated CDS plugin library (cds-plugin-ui5). Do you want to enable this feature? (Note: this is requirement for generating with TypeScript)",
+        "appEnableNpmWorkspacesBreadcrumb": "Enable NPM Workspaces",
+        "appEnableTypeScriptMessage": "Enable TypeScript",
+        "appShowAdvancedOptionsMessage": "Configure advanced options",
+        "appShowAdvancedOptionsHint": "Choosing 'No' will apply defaults"
+    },
+    "validators": {
+        "appFolderExistsAtPath": "A module with this name already exists in the folder: {{-path}}"
+    },
+    "ui5VersionLabels": {
+        "maintained": "Maintained",
+        "outOfMaintenance": "Out of maintenance",
+        "version_one": "version",
+        "version_other": "versions"
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,125 @@
+import type { PromptSeverityMessage, UI5VersionChoice, YUIQuestion, validate } from '@sap-ux/inquirer-common';
+import type { AsyncDynamicQuestionProperty } from 'inquirer';
+import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
+export interface UI5ApplicationAnswers {
+    name?: string;
+    title?: string;
+    namespace?: string;
+    description?: string;
+    targetFolder?: string;
+    ui5Version?: string;
+    addDeployConfig?: boolean;
+    addFlpConfig?: boolean;
+    ui5Theme?: string;
+    enableEslint?: boolean;
+    enableCodeAssist?: boolean;
+    skipAnnotations?: boolean;
+    enableTypeScript?: boolean;
+    enableNPMWorkspaces?: boolean;
+    showAdvanced?: boolean;
+}
+/**
+ * Enumeration of prompt names used by UI5ApplicationInquirerPromptOptions
+ *
+ */
+export declare enum promptNames {
+    /**
+     * Application name
+     */
+    name = "name",
+    /**
+     * Application title
+     */
+    title = "title",
+    /**
+     * Application namespace
+     */
+    namespace = "namespace",
+    /**
+     * Application description
+     */
+    description = "description",
+    /**
+     * Target folder for generated application
+     */
+    targetFolder = "targetFolder",
+    /**
+     * Application ui5 version
+     */
+    ui5Version = "ui5Version",
+    addDeployConfig = "addDeployConfig",
+    addFlpConfig = "addFlpConfig",
+    ui5Theme = "ui5Theme",
+    enableEslint = "enableEslint",
+    enableNPMWorkspaces = "enableNPMWorkspaces",
+    enableCodeAssist = "enableCodeAssist",
+    skipAnnotations = "skipAnnotations",
+    enableTypeScript = "enableTypeScript",
+    showAdvanced = "showAdvanced"
+}
+type UI5VersionPromptOptions = {
+    /**
+     * Specifies the minimum UI5 version to consider when fetching UI5 versions
+     */
+    minUI5Version?: string;
+    /**
+     * Optionally include an Inquirer Separator for grouped UI5 versions
+     */
+    includeSeparators?: boolean;
+    /**
+     * Optionally register the `inquirer-autocomplete-prompt` plugin and use for UI5 version searching.
+     * If the default `false` is used then standard prompting will be used that require scrolling to find entries.
+     */
+    useAutocomplete?: boolean;
+    /**
+     * Choice will be added to the UI5 versions offered and set as the default selection
+     *
+     */
+    defaultChoice?: UI5VersionChoice;
+};
+/**
+ * These are boolean value prompt option keys
+ */
+type booleanPromptKeys = 'addDeployConfig' | 'addFlpConfig' | 'enableEslint' | 'skipAnnotations' | 'enableTypeScript' | 'enableCodeAssist' | 'showAdvanced' | 'enableNPMWorkspaces';
+type stringValuePromptType = Omit<typeof promptNames, booleanPromptKeys>;
+type stringValuePrompts = stringValuePromptType[keyof stringValuePromptType];
+type booleanValuePromptType = Pick<typeof promptNames, booleanPromptKeys>;
+type booleanValuePrompts = booleanValuePromptType[keyof booleanValuePromptType];
+type DefaultValueInputPrompts = promptNames.name | promptNames.description | promptNames.namespace | promptNames.ui5Version | promptNames.targetFolder;
+type DefaultValueConfirmPrompts = promptNames.enableCodeAssist | promptNames.enableEslint | promptNames.skipAnnotations | promptNames.enableTypeScript;
+export type PromptDefaultValue<T> = {
+    default?: AsyncDynamicQuestionProperty<T>;
+};
+/**
+ * Defines prompt/question default values and/or whether or not they should be shown.
+ */
+export type CommonPromptOptions = {
+    hide?: boolean;
+    advancedOption?: boolean;
+    validate?: validate<UI5ApplicationAnswers>;
+    additionalMessages?: PromptSeverityMessage;
+};
+/**
+ * Provide the correct type checking for string value prompts and `ui5Version` options
+ *
+ */
+type stringValuePromptOptions = Record<stringValuePrompts, CommonPromptOptions> & Record<DefaultValueInputPrompts, PromptDefaultValue<string>> & Record<promptNames.ui5Version, UI5VersionPromptOptions>;
+/**
+ * Provide the correct type checking for boolean value prompts and validator callback options
+ *
+ */
+type booleanValuePromptOtions = Record<booleanValuePrompts, {
+    /**
+     * Callback function can be provided which will be executed on input validation.
+     * This may be used, for example, to trigger conditional steps in Yeoman UI.
+     *
+     * @param answer
+     * @param promptName
+     * @returns
+     */
+    validatorCallback?: (answer: boolean, promptName: string) => void;
+} & CommonPromptOptions> & Record<DefaultValueConfirmPrompts, PromptDefaultValue<boolean>>;
+export type UI5ApplicationQuestion = YUIQuestion<UI5ApplicationAnswers> & Partial<Pick<AutocompleteQuestionOptions, 'source'>>;
+export type UI5ApplicationPromptOptions = Partial<stringValuePromptOptions & booleanValuePromptOtions>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptNames = void 0;
+/**
+ * Enumeration of prompt names used by UI5ApplicationInquirerPromptOptions
+ *
+ */
+var promptNames;
+(function (promptNames) {
+    /**
+     * Application name
+     */
+    promptNames["name"] = "name";
+    /**
+     * Application title
+     */
+    promptNames["title"] = "title";
+    /**
+     * Application namespace
+     */
+    promptNames["namespace"] = "namespace";
+    /**
+     * Application description
+     */
+    promptNames["description"] = "description";
+    /**
+     * Target folder for generated application
+     */
+    promptNames["targetFolder"] = "targetFolder";
+    /**
+     * Application ui5 version
+     */
+    promptNames["ui5Version"] = "ui5Version";
+    promptNames["addDeployConfig"] = "addDeployConfig";
+    promptNames["addFlpConfig"] = "addFlpConfig";
+    promptNames["ui5Theme"] = "ui5Theme";
+    promptNames["enableEslint"] = "enableEslint";
+    promptNames["enableNPMWorkspaces"] = "enableNPMWorkspaces";
+    promptNames["enableCodeAssist"] = "enableCodeAssist";
+    promptNames["skipAnnotations"] = "skipAnnotations";
+    promptNames["enableTypeScript"] = "enableTypeScript";
+    promptNames["showAdvanced"] = "showAdvanced";
+})(promptNames || (exports.promptNames = promptNames = {}));
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@sap-ux/ui5-application-inquirer",
+  "description": "Prompts module that can prompt users for inputs required for UI5 application writing",
+  "version": "0.2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/ui5-application-inquirer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aui5-application-inquirer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "i18next": "23.5.1",
+    "inquirer-autocomplete-prompt": "2.0.1",
+    "lodash": "4.17.21",
+    "semver": "7.5.4",
+    "@sap-ux/inquirer-common": "0.2.0",
+    "@sap-ux/project-access": "1.17.5",
+    "@sap-ux/project-input-validator": "0.2.3",
+    "@sap-ux/ui5-info": "0.3.2"
+  },
+  "devDependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "@types/inquirer-autocomplete-prompt": "2.0.1",
+    "@types/inquirer": "8.2.6",
+    "@types/lodash": "4.14.202",
+    "@types/semver": "7.5.4",
+    "inquirer": "8.2.6",
+    "@sap-ux/cap-config-writer": "0.2.17"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}