@sap-ux/ui5-library-inquirer 0.1.1 → 0.2.0

package/README.md

@@ -15,7 +15,7 @@ Pnpm
 
 ## Usage
 
-Example with Yeoman generator :
+Example with Yeoman generator no options, e.g. cli prompting only :
 
 ```javascript
 import Generator from 'yeoman-generator';
@@ -51,6 +51,51 @@ export default class UI5LibraryGenerator extends Generator {
 }
 ```
 
+Example with Yeoman generator passing options with adapter, e.g. @sap-devx/yeoman-ui integration :
+
+```javascript
+import Generator from 'yeoman-generator';
+import { generate, type UI5LibConfig } from '@sap-ux/ui5-library-writer';
+import { prompt, type UI5LibraryAnswers } from '@sap-ux/ui5-library-inquirer';
+
+export default class UI5LibraryGenerator extends Generator {
+    answers: UI5LibraryAnswers = {};
+    targetFolder: string;
+ 
+    constructor(args: string | string[], opts: Generator.GeneratorOptions) {
+        super(args, opts);
+        this.targetFolder = opts.targetFolder;
+    }
+
+    public async prompting(): Promise<void> {
+        const answers = await prompt(
+            {
+                targetFolder: this.targetFolder,
+                includeSeparators: true,
+                useAutocomplete: false
+            },
+            this.env?.adapter
+        );
+        Object.assign(this.answers, answers);
+    }
+
+     public async writing(): Promise<void> {
+        const ui5Lib: UI5LibConfig = {
+            libraryName: this.answers.libraryName,
+            namespace: this.answers.namespace,
+            framework: 'SAPUI5',
+            frameworkVersion: this.answers.ui5Version,
+            author: 'Fiori tools',
+            typescript: this.answers.enableTypescript
+        };
+
+        try {
+            await generate(this.answers.targetFolder, ui5Lib, this.fs);
+        } catch (e) {}
+    }
+}
+```
+
 ## Keywords
 SAP Fiori Elements
 Yeoman

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { type Question } from 'inquirer';
-import type { UI5LibraryAnswers, UI5LibraryPromptOptions } from './types';
+import type { InquirerAdapter, UI5LibraryAnswers, UI5LibraryPromptOptions } from './types';
 /**
  * Get the inquirer prompts for ui5 library inquirer.
  *
@@ -10,9 +10,10 @@ declare function getPrompts(promptOptions?: UI5LibraryPromptOptions): Promise<Qu
 /**
  * Prompt for ui5 library generation inputs.
  *
- * @param promptOptions - options that can control some of the prompt behaviour. See {@link UI5LibraryPromptOptions} for details
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link UI5LibraryPromptOptions} for details
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
  * @returns the prompt answers
  */
-declare function prompt(promptOptions?: UI5LibraryPromptOptions): Promise<UI5LibraryAnswers>;
+declare function prompt(promptOptions?: UI5LibraryPromptOptions, adapter?: InquirerAdapter): Promise<UI5LibraryAnswers>;
 export { getPrompts, prompt, type UI5LibraryPromptOptions, type UI5LibraryAnswers };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -42,16 +42,18 @@ exports.getPrompts = getPrompts;
 /**
  * Prompt for ui5 library generation inputs.
  *
- * @param promptOptions - options that can control some of the prompt behaviour. See {@link UI5LibraryPromptOptions} for details
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link UI5LibraryPromptOptions} for details
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
  * @returns the prompt answers
  */
-function prompt(promptOptions) {
+function prompt(promptOptions, adapter) {
     return __awaiter(this, void 0, void 0, function* () {
         const ui5LibPrompts = yield exports.getPrompts(promptOptions);
+        const pm = adapter ? adapter.promptModule : inquirer_1.default;
         if (promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions.useAutocomplete) {
-            inquirer_1.default.registerPrompt('autocomplete', inquirer_autocomplete_prompt_1.default);
+            pm.registerPrompt('autocomplete', inquirer_autocomplete_prompt_1.default);
         }
-        return inquirer_1.default.prompt(ui5LibPrompts);
+        return adapter ? adapter.prompt(ui5LibPrompts) : inquirer_1.default.prompt(ui5LibPrompts);
     });
 }
 exports.prompt = prompt;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, Answers, ListChoiceOptions } from 'inquirer';
+import type { ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, Answers, ListChoiceOptions, PromptFunction, PromptModule } from 'inquirer';
 export interface UI5LibraryAnswers {
     libraryName?: string;
     namespace?: string;
@@ -23,6 +23,10 @@ export interface UI5LibraryPromptOptions {
 export interface UI5VersionChoice extends ListChoiceOptions {
     value: string;
 }
+export interface InquirerAdapter {
+    prompt: PromptFunction;
+    promptModule: PromptModule;
+}
 /**
  *
  * Remove when YUI specific types are available from `"@sap-devx/yeoman-ui-types`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-library-inquirer",
   "description": "Prompts module that can provide prompts for UI5 library writer",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,11 +25,11 @@
     "inquirer": "8.2.6",
     "inquirer-autocomplete-prompt": "2.0.1",
     "@sap-ux/project-input-validator": "0.2.1",
-    "@sap-ux/ui5-info": "0.2.0"
+    "@sap-ux/ui5-info": "0.2.1"
   },
   "devDependencies": {
     "@types/inquirer-autocomplete-prompt": "2.0.1",
-    "@types/inquirer": "8.2.7"
+    "@types/inquirer": "8.2.6"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",