cli-questionnaire 1.0.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2025 Edmar Langendoen
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,185 @@
+# CLI Questionnaire 🎯
+
+A CLI tool built with TypeScript for creating interactive questionnaires.
+
+## Table of Contents 📚
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Build](#build)
+- [Testing](#testing)
+- [License](#license)
+
+## Installation ⚙️
+
+### From npm (once published)
+
+You can install the package globally using npm:
+
+```sh
+npm install -g cli-questionnaire
+```
+
+Or use it directly with `npx`:
+
+```sh
+npx cli-questionnaire
+```
+
+### From Source 🛠️
+
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/elangendoen/cli-questionnaire.git
+   cd cli-questionnaire
+   ```
+2. Install dependencies:
+
+   ```sh
+   npm install
+   ```
+
+3. Build the project:
+   ```sh
+   npm run build
+   ```
+
+## Usage 🚀
+
+### Using the CLI
+
+Once installed globally or via `npx`, you can run the CLI tool:
+
+```sh
+cli-questionnaire
+```
+
+### Programmatic Usage 🖥️
+
+You can also use the `Prompt` function programmatically in your TypeScript or JavaScript projects:
+
+```typescript
+import { Prompt, Question } from 'cli-questionnaire';
+
+const questions: Question[] = [
+  {
+    id: 'q1',
+    type: 'multiple-choice',
+    question: 'What is your favorite programming language?',
+    options: ['JavaScript', 'TypeScript', 'Python'],
+  },
+  {
+    id: 'q2',
+    type: 'open',
+    question: 'What is your name?',
+    allowBackNavigation: true,
+  },
+  {
+    id: 'q3',
+    type: 'number',
+    question: 'How many years of experience do you have in programming?',
+    condition: (answers) => {
+      const q1Answer = answers.find((a) => a.id === 'q1')?.answer;
+      return q1Answer === 'TypeScript';
+    },
+  },
+];
+
+(async () => {
+  const answers = await Prompt({
+    questions,
+    allowBackNavigation: true,
+    allowSkip: true,
+  });
+
+  console.log('Your answers:', answers);
+})();
+```
+
+#### Question Properties 📝
+
+Each question in the `questions` array can have the following properties:
+
+- **`id`** (required): A unique identifier for the question.
+- **`type`** (required): The type of question. Can be one of:
+  - `'multiple-choice'`: A question with predefined options.
+  - `'open'`: A free-text question.
+  - `'number'`: A question expecting a numeric answer.
+- **`question`** (required): The text of the question to display to the user.
+- **`options`** (required for `'multiple-choice'`): An array of strings representing the available options.
+- **`allowBackNavigation`** (optional): A boolean indicating whether the user can navigate back to this question. Defaults to `false`.
+- **`allowSkip`** (optional): A boolean indicating whether the user can skip this question. Defaults to `false`.
+- **`condition`** (optional): A function that determines whether this question should be asked. The function receives the current `answers` array and should return `true` or `false`.
+
+---
+
+### Question Types with Examples 🛠️
+
+Here are examples of the different question types supported by the `Prompt` function:
+
+#### Multiple-Choice Question
+
+A question with predefined options that the user can select from:
+
+```typescript
+{
+  id: 'q1',
+  type: 'multiple-choice',
+  question: 'What is your favorite programming language?',
+  options: ['JavaScript', 'TypeScript', 'Python', 'Java'],
+}
+```
+
+#### Open Question
+
+A free-text question where the user can type their answer:
+
+```typescript
+{
+  id: 'q1',
+  type: 'open',
+  question: 'What is your name?',
+}
+```
+
+#### Number Question
+
+A question expecting a numeric answer:
+
+```typescript
+{
+  id: 'q1',
+  type: 'number',
+  question: 'How many years of experience do you have in programming?',
+}
+```
+
+---
+
+## Build 🏗️
+
+To compile the TypeScript code to JavaScript, run:
+
+```sh
+npm run build
+```
+
+The compiled files will be output to the `dist` directory.
+
+## Testing 🧪
+
+Run the tests using Jest:
+
+```sh
+npm test
+```
+
+To generate a coverage report:
+
+```sh
+npm run coverage
+```
+
+## License 📜
+
+This project is licensed under the ISC License.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { Prompt } from './prompt';
+export type { Question, Answer } from './types';

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prompt = void 0;
+var prompt_1 = require("./prompt");
+Object.defineProperty(exports, "Prompt", { enumerable: true, get: function () { return prompt_1.Prompt; } });
+// import { Prompt } from './prompt';
+// import { Question } from './types';
+// (async () => {
+//   const questions: Question[] = [
+//     {
+//       id: 'q1',
+//       type: 'multiple-choice',
+//       question: 'What is your favorite programming language?',
+//       options: ['JavaScript', 'TypeScript', 'Python', 'Java'],
+//     },
+//     {
+//       id: 'q2',
+//       type: 'open',
+//       question: 'What is your name?',
+//       allowBackNavigation: true,
+//     },
+//     {
+//       id: 'q3',
+//       type: 'number',
+//       question: 'How many years of experience do you have in programming?',
+//       condition: (answers) => {
+//         // Only ask this question if the user selected "TypeScript" in q1
+//         const q1Answer = answers.find((a) => a.id === 'q1')?.answer;
+//         return q1Answer === 'TypeScript';
+//       },
+//     },
+//     {
+//       id: 'q4',
+//       type: 'open',
+//       question: 'What is your last name?',
+//       allowBackNavigation: true,
+//     },
+//   ];
+//   const answers = await Prompt({
+//     questions,
+//     allowBackNavigation: true,
+//     allowSkip: true,
+//   });
+//   console.log('\nYour answers:', answers);
+// })();

package/dist/prompt/handlers/conditionHandler.d.ts

@@ -0,0 +1,2 @@
+import { Question, Answer } from '../../types';
+export declare function handleCondition(question: Question, answers: Answer[]): boolean;

package/dist/prompt/handlers/conditionHandler.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleCondition = handleCondition;
+function handleCondition(question, answers) {
+    return question.condition ? question.condition(answers) : true;
+}

package/dist/prompt/handlers/multipleChoiceHandler.d.ts

@@ -0,0 +1,3 @@
+import { Answer, MultipleChoiceQuestion } from '../../types';
+import * as readline from 'readline';
+export declare function handleMultipleChoice(question: MultipleChoiceQuestion, answers: Answer[], rl: readline.Interface, allowBackNavigation: boolean, allowSkip: boolean, currentIndex: number): Promise<string | number | 'back' | 'skip'>;

package/dist/prompt/handlers/multipleChoiceHandler.js

@@ -0,0 +1,48 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleMultipleChoice = handleMultipleChoice;
+const helpers_1 = require("../helpers");
+function handleMultipleChoice(question, answers, rl, allowBackNavigation, allowSkip, currentIndex) {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log(`\n${question.question}`);
+        question.options.forEach((option, index) => {
+            console.log(`${index + 1}. ${option}`);
+        });
+        // Add "Go Back" and "Skip" options if applicable
+        const extraOptions = [];
+        if (allowBackNavigation && currentIndex > 0) {
+            extraOptions.push('b. Go Back');
+        }
+        if (allowSkip) {
+            extraOptions.push('s. Skip');
+        }
+        if (extraOptions.length > 0) {
+            console.log('\nAdditional Options:');
+            extraOptions.forEach((option) => {
+                console.log(option);
+            });
+        }
+        const choice = yield (0, helpers_1.askQuestion)(rl, 'Choose an option (number or letter): ');
+        const index = parseInt(choice, 10) - 1;
+        if (allowBackNavigation && currentIndex > 0 && choice.toLowerCase() === 'b') {
+            return 'back';
+        }
+        if (allowSkip && choice.toLowerCase() === 's') {
+            return 'skip';
+        }
+        if (index >= 0 && index < question.options.length) {
+            return question.options[index];
+        }
+        console.log('Invalid choice. Please try again.');
+        return yield handleMultipleChoice(question, answers, rl, allowBackNavigation, allowSkip, currentIndex);
+    });
+}

package/dist/prompt/handlers/numberHandler.d.ts

@@ -0,0 +1,3 @@
+import { Question } from '../../types';
+import * as readline from 'readline';
+export declare function handleNumber(question: Question, rl: readline.Interface, allowBackNavigation: boolean, allowSkip: boolean, currentIndex: number): Promise<number | 'back' | 'skip'>;

package/dist/prompt/handlers/numberHandler.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleNumber = handleNumber;
+const helpers_1 = require("../helpers");
+function handleNumber(question, rl, allowBackNavigation, allowSkip, currentIndex) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let extraOptions = '';
+        if (allowBackNavigation && currentIndex > 0) {
+            extraOptions += ' (b: Go Back';
+        }
+        if (allowSkip) {
+            extraOptions += `${extraOptions ? ', ' : ' ('}s: Skip`;
+        }
+        extraOptions += extraOptions ? ')' : '';
+        const response = yield (0, helpers_1.askQuestion)(rl, `${question.question}${extraOptions}: `);
+        if (allowBackNavigation &&
+            currentIndex > 0 &&
+            response.toLowerCase() === 'b') {
+            return 'back';
+        }
+        if (allowSkip && response.toLowerCase() === 's') {
+            return 'skip';
+        }
+        const numberResponse = parseFloat(response);
+        if (!isNaN(numberResponse)) {
+            return numberResponse;
+        }
+        console.log('Invalid number. Please try again.');
+        return yield handleNumber(question, rl, allowBackNavigation, allowSkip, currentIndex);
+    });
+}

package/dist/prompt/handlers/openHandler.d.ts

@@ -0,0 +1,3 @@
+import { Question } from '../../types';
+import * as readline from 'readline';
+export declare function handleOpen(question: Question, rl: readline.Interface, allowBackNavigation: boolean, allowSkip: boolean, currentIndex: number): Promise<string | 'back' | 'skip'>;

package/dist/prompt/handlers/openHandler.js

@@ -0,0 +1,35 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleOpen = handleOpen;
+const helpers_1 = require("../helpers");
+function handleOpen(question, rl, allowBackNavigation, allowSkip, currentIndex) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let extraOptions = '';
+        if (allowBackNavigation && currentIndex > 0) {
+            extraOptions += ' (b: Go Back';
+        }
+        if (allowSkip) {
+            extraOptions += `${extraOptions ? ', ' : ' ('}s: Skip`;
+        }
+        extraOptions += extraOptions ? ')' : '';
+        const response = yield (0, helpers_1.askQuestion)(rl, `${question.question}${extraOptions}: `);
+        if (allowBackNavigation &&
+            currentIndex > 0 &&
+            response.toLowerCase() === 'b') {
+            return 'back';
+        }
+        if (allowSkip && response.toLowerCase() === 's') {
+            return 'skip';
+        }
+        return response;
+    });
+}

package/dist/prompt/helpers.d.ts

@@ -0,0 +1,2 @@
+import * as readline from 'readline';
+export declare const askQuestion: (rl: readline.Interface, query: string) => Promise<string>;

package/dist/prompt/helpers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askQuestion = void 0;
+const askQuestion = (rl, query) => {
+    return new Promise((resolve) => rl.question(query, resolve));
+};
+exports.askQuestion = askQuestion;

package/dist/prompt/index.d.ts

@@ -0,0 +1,8 @@
+import { Question, Answer } from '../types';
+interface PromptParams {
+    questions: Question[];
+    allowBackNavigation?: boolean;
+    allowSkip?: boolean;
+}
+export declare function Prompt({ questions, allowBackNavigation, allowSkip, }: PromptParams): Promise<Answer[]>;
+export {};

package/dist/prompt/index.js

@@ -0,0 +1,82 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prompt = Prompt;
+const readline = require("readline");
+const multipleChoiceHandler_1 = require("./handlers/multipleChoiceHandler");
+const openHandler_1 = require("./handlers/openHandler");
+const numberHandler_1 = require("./handlers/numberHandler");
+const conditionHandler_1 = require("./handlers/conditionHandler");
+function Prompt(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ questions, allowBackNavigation = false, allowSkip = false, }) {
+        var _b, _c;
+        const answers = [];
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        let currentIndex = 0;
+        try {
+            while (currentIndex < questions.length) {
+                const question = questions[currentIndex];
+                // Check the condition function, if it exists
+                if (!(0, conditionHandler_1.handleCondition)(question, [...answers])) {
+                    // Skip the question if the condition returns false
+                    answers.push({ id: question.id, answer: undefined });
+                    currentIndex++;
+                    continue;
+                }
+                const backNavigationAllowed = (_b = question.allowBackNavigation) !== null && _b !== void 0 ? _b : allowBackNavigation;
+                const skipAllowed = (_c = question.allowSkip) !== null && _c !== void 0 ? _c : allowSkip;
+                let userAnswer = undefined;
+                // Delegate to the appropriate handler based on question type
+                switch (question.type) {
+                    case 'multiple-choice':
+                        userAnswer = yield (0, multipleChoiceHandler_1.handleMultipleChoice)(question, [...answers], // Pass a copy of the current answers
+                        rl, backNavigationAllowed, skipAllowed, currentIndex);
+                        break;
+                    case 'open':
+                        userAnswer = yield (0, openHandler_1.handleOpen)(question, rl, backNavigationAllowed, skipAllowed, currentIndex);
+                        break;
+                    case 'number':
+                        userAnswer = yield (0, numberHandler_1.handleNumber)(question, rl, backNavigationAllowed, skipAllowed, currentIndex);
+                        break;
+                    default:
+                        console.log('Unknown question type. Skipping question.');
+                        userAnswer = undefined;
+                }
+                // Handle navigation
+                if (userAnswer === 'back') {
+                    if (currentIndex > 0) {
+                        currentIndex--;
+                        answers.pop(); // Remove the last answer
+                    }
+                    else {
+                        console.log('You are already at the first question. Cannot go back.');
+                    }
+                    continue;
+                }
+                else if (userAnswer === 'skip') {
+                    answers.push({ id: question.id, answer: undefined });
+                }
+                else {
+                    answers.push({ id: question.id, answer: userAnswer });
+                }
+                currentIndex++;
+            }
+        }
+        finally {
+            // Ensure the readline interface is always closed
+            rl.close();
+        }
+        return answers;
+    });
+}

package/dist/types/index.d.ts

@@ -0,0 +1,24 @@
+export type QuestionType = 'multiple-choice' | 'open' | 'number';
+export interface MultipleChoiceQuestion {
+    id: string;
+    type: 'multiple-choice';
+    question: string;
+    options: string[];
+    allowBackNavigation?: boolean;
+    allowSkip?: boolean;
+    condition?: (answers: Answer[]) => boolean;
+}
+export interface OpenOrNumberQuestion {
+    id: string;
+    type: 'open' | 'number';
+    question: string;
+    options?: undefined;
+    allowBackNavigation?: boolean;
+    allowSkip?: boolean;
+    condition?: (answers: Answer[]) => boolean;
+}
+export type Question = MultipleChoiceQuestion | OpenOrNumberQuestion;
+export type Answer = {
+    id: string;
+    answer: string | number | undefined;
+};

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "cli-questionnaire",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "cli-questionnaire": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "start": "ts-node src/index.ts",
+    "test": "jest --forceExit",
+    "coverage": "jest --coverage"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/elangendoen/cli-questionnaire.git"
+  },
+  "keywords": ["cli", "questionnaire", "interactive", "prompts"],
+  "author": "Edmar Langendoen",
+  "license": "ISC",
+  "description": "A CLI questionnaire tool for interactive prompts.",
+  "devDependencies": {
+    "@eslint/js": "^9.26.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.15.3",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.3.1",
+    "globals": "^16.0.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.3.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.31.1"
+  }
+}