mepcli 0.2.0 → 0.2.5

package/README.md

@@ -1,13 +1,13 @@
-# Mep: Minimalist CLI Prompt
+# Mep
 
 **Mep** is a minimalist and zero-dependency library for creating interactive command-line prompts in Node.js. It focuses on simplicity, modern design, and robust input handling, including support for cursor movement and input validation.
 
 ## Features
 
 - **Zero Dependency:** Keeps your project clean and fast.
-- **Full-Featured Prompts:** Includes `text`, `password`, `select`, ch`eckbox, and `confirm`.
-- **Responsive Input:** Supports cursor movement (Left/Right) and character insertion/deletion in `text` and `password` prompts.
-- **Validation:** Built-in support for input validation with custom error messages.
+- **Comprehensive Prompts:** Includes `text`, `password`, `select`, `checkbox`, `confirm`, `number`, `toggle`, `list`, `slider`, `date`, `file`, and `multiSelect`.
+- **Responsive Input:** Supports cursor movement (Left/Right) and character insertion/deletion in text-based prompts.
+- **Validation:** Built-in support for input validation (sync and async) with custom error messages.
 - **Elegant Look:** Uses ANSI colors for a clean, modern CLI experience.
 
 ## Installation
@@ -21,31 +21,75 @@ yarn add mepcli
 ## Usage Example
 
 Mep provides a static class facade, `MepCLI`, for all interactions.
-```javascript
+
+```typescript
 import { MepCLI } from 'mepcli';
 
-async function setup() {
-    // Text input with validation and cursor support
-    const projectName = await MepCLI.text({
-        message: "Enter the project name:",
-        validate: (v) => v.length > 5 || "Must be longer than 5 chars",
+async function main() {
+    // Text input with validation
+    const name = await MepCLI.text({
+        message: "Enter your name:",
+        placeholder: "John Doe",
+        validate: (v) => v.length > 0 || "Name cannot be empty"
+    });
+
+    // Number input
+    const age = await MepCLI.number({
+        message: "How old are you?",
+        min: 1,
+        max: 120
+    });
+
+    // Toggle (Switch)
+    const newsletter = await MepCLI.toggle({
+        message: "Subscribe to newsletter?",
+        initial: true
     });
 
     // Select menu
-    const choice = await MepCLI.select({
-        message: "Choose an option:",
+    const lang = await MepCLI.select({
+        message: "Preferred Language:",
+        choices: [
+            { title: "JavaScript", value: "js" },
+            { title: "TypeScript", value: "ts" },
+            { title: "Python", value: "py" }
+        ]
+    });
+
+    // Checkbox (Multiple choice)
+    const tools = await MepCLI.checkbox({
+        message: "Select tools:",
         choices: [
-            { title: "Option A", value: 1 },
-            { title: "Option B", value: 2 }
+            { title: "ESLint", value: "eslint" },
+            { title: "Prettier", value: "prettier", selected: true },
+            { title: "Jest", value: "jest" }
         ]
     });
 
-    console.log(`\nProject: ${projectName}, Selected: ${choice}`);
+    console.log({ name, age, newsletter, lang, tools });
 }
 
-setup();
+main();
 ```
 
+## API Reference
+
+### MepCLI
+
+*   `text(options)` - Single line or multiline text input.
+*   `password(options)` - Masked text input.
+*   `number(options)` - Numeric input with increment/decrement support.
+*   `confirm(options)` - Yes/No question.
+*   `toggle(options)` - On/Off switch.
+*   `select(options)` - Single item selection from a list.
+*   `multiSelect(options)` - Multiple item selection with filtering.
+*   `checkbox(options)` - Classic checkbox selection.
+*   `list(options)` - Enter a list of tags/strings.
+*   `slider(options)` - Select a number within a range using a visual slider.
+*   `date(options)` - Date and time picker.
+*   `file(options)` - File system navigator and selector.
+*   `spin(message, promise)` - Display a spinner while waiting for a promise.
+
 ## License
 
-This project is under the **MIT License**.
+This project is under the **MIT License**.

package/dist/ansi.d.ts

@@ -7,6 +7,7 @@ export declare const ANSI: {
     BOLD: string;
     DIM: string;
     ITALIC: string;
+    UNDERLINE: string;
     FG_GREEN: string;
     FG_CYAN: string;
     FG_YELLOW: string;
@@ -14,6 +15,7 @@ export declare const ANSI: {
     FG_GRAY: string;
     FG_WHITE: string;
     ERASE_LINE: string;
+    ERASE_DOWN: string;
     CURSOR_LEFT: string;
     HIDE_CURSOR: string;
     SHOW_CURSOR: string;

package/dist/ansi.js

@@ -10,6 +10,7 @@ exports.ANSI = {
     BOLD: '\x1b[1m',
     DIM: '\x1b[2m',
     ITALIC: '\x1b[3m',
+    UNDERLINE: '\x1b[4m',
     // Colors
     FG_GREEN: '\x1b[32m',
     FG_CYAN: '\x1b[36m',
@@ -19,6 +20,7 @@ exports.ANSI = {
     FG_WHITE: '\x1b[37m',
     // Cursor & Erasing
     ERASE_LINE: '\x1b[2K', // Clear current line
+    ERASE_DOWN: '\x1b[J', // Clear from cursor to end of screen
     CURSOR_LEFT: '\x1b[1000D', // Move cursor to start of line
     HIDE_CURSOR: '\x1b[?25l',
     SHOW_CURSOR: '\x1b[?25h',

package/dist/base.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Abstract base class for all prompts.
+ * Handles common logic like stdin management, raw mode, and cleanup
+ * to enforce DRY (Don't Repeat Yourself) principles.
+ */
+export declare abstract class Prompt<T, O> {
+    protected options: O;
+    protected value: any;
+    protected stdin: NodeJS.ReadStream;
+    protected stdout: NodeJS.WriteStream;
+    private _resolve?;
+    private _reject?;
+    private _onDataHandler?;
+    constructor(options: O);
+    /**
+     * Renders the UI. Must be implemented by subclasses.
+     * @param firstRender Indicates if this is the initial render.
+     */
+    protected abstract render(firstRender: boolean): void;
+    /**
+     * Handles specific key inputs. Must be implemented by subclasses.
+     * @param char The string representation of the key.
+     * @param key The raw buffer.
+     */
+    protected abstract handleInput(char: string, key: Buffer): void;
+    protected print(text: string): void;
+    /**
+     * Starts the prompt interaction.
+     * Sets up raw mode and listeners, returning a Promise.
+     */
+    run(): Promise<T>;
+    /**
+     * Cleans up listeners and restores stdin state.
+     */
+    protected cleanup(): void;
+    /**
+     * Submits the final value and resolves the promise.
+     */
+    protected submit(result: T): void;
+    protected isUp(char: string): boolean;
+    protected isDown(char: string): boolean;
+    protected isRight(char: string): boolean;
+    protected isLeft(char: string): boolean;
+}

package/dist/base.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Prompt = void 0;
+const ansi_1 = require("./ansi");
+/**
+ * Abstract base class for all prompts.
+ * Handles common logic like stdin management, raw mode, and cleanup
+ * to enforce DRY (Don't Repeat Yourself) principles.
+ */
+class Prompt {
+    constructor(options) {
+        this.options = options;
+        this.stdin = process.stdin;
+        this.stdout = process.stdout;
+    }
+    print(text) {
+        this.stdout.write(text);
+    }
+    /**
+     * Starts the prompt interaction.
+     * Sets up raw mode and listeners, returning a Promise.
+     */
+    run() {
+        return new Promise((resolve, reject) => {
+            this._resolve = resolve;
+            this._reject = reject;
+            if (typeof this.stdin.setRawMode === 'function') {
+                this.stdin.setRawMode(true);
+            }
+            this.stdin.resume();
+            this.stdin.setEncoding('utf8');
+            // Initial render: Default to hidden cursor (good for menus)
+            // Subclasses like TextPrompt will explicitly show it if needed.
+            this.print(ansi_1.ANSI.HIDE_CURSOR);
+            this.render(true);
+            this._onDataHandler = (buffer) => {
+                const char = buffer.toString();
+                // Global Exit Handler (Ctrl+C)
+                if (char === '\u0003') {
+                    this.cleanup();
+                    this.print(ansi_1.ANSI.SHOW_CURSOR + '\n');
+                    if (this._reject)
+                        this._reject(new Error('User force closed'));
+                    return;
+                }
+                this.handleInput(char, buffer);
+            };
+            this.stdin.on('data', this._onDataHandler);
+        });
+    }
+    /**
+     * Cleans up listeners and restores stdin state.
+     */
+    cleanup() {
+        if (this._onDataHandler) {
+            this.stdin.removeListener('data', this._onDataHandler);
+        }
+        if (typeof this.stdin.setRawMode === 'function') {
+            this.stdin.setRawMode(false);
+        }
+        this.stdin.pause();
+        this.print(ansi_1.ANSI.SHOW_CURSOR);
+    }
+    /**
+     * Submits the final value and resolves the promise.
+     */
+    submit(result) {
+        this.cleanup();
+        this.print('\n');
+        if (this._resolve)
+            this._resolve(result);
+    }
+    // Helper to check for arrow keys including application mode
+    isUp(char) {
+        return char === '\u001b[A' || char === '\u001bOA';
+    }
+    isDown(char) {
+        return char === '\u001b[B' || char === '\u001bOB';
+    }
+    isRight(char) {
+        return char === '\u001b[C' || char === '\u001bOC';
+    }
+    isLeft(char) {
+        return char === '\u001b[D' || char === '\u001bOD';
+    }
+}
+exports.Prompt = Prompt;

package/dist/core.d.ts

@@ -1,4 +1,4 @@
-import { TextOptions, SelectOptions, ConfirmOptions, CheckboxOptions, ThemeConfig, NumberOptions, ToggleOptions } from './types';
+import { TextOptions, SelectOptions, ConfirmOptions, CheckboxOptions, ThemeConfig, NumberOptions, ToggleOptions, ListOptions, SliderOptions, DateOptions, FileOptions, MultiSelectOptions } from './types';
 /**
  * Public Facade for MepCLI
  */
@@ -15,4 +15,9 @@ export declare class MepCLI {
     static password(options: TextOptions): Promise<string>;
     static number(options: NumberOptions): Promise<number>;
     static toggle(options: ToggleOptions): Promise<boolean>;
+    static list(options: ListOptions): Promise<string[]>;
+    static slider(options: SliderOptions): Promise<number>;
+    static date(options: DateOptions): Promise<Date>;
+    static file(options: FileOptions): Promise<string>;
+    static multiSelect(options: MultiSelectOptions): Promise<any[]>;
 }