cli-menu-kit 0.1.0

package/dist/core/renderer.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Base rendering functions for CLI Menu Kit
+ * Provides utilities for rendering menu components
+ */
+/**
+ * Render a blank line
+ * @param count - Number of blank lines (default: 1)
+ */
+export declare function renderBlankLines(count?: number): void;
+/**
+ * Render a header
+ * @param text - Header text
+ * @param color - Optional color
+ */
+export declare function renderHeader(text: string, color?: string): void;
+/**
+ * Render an option line
+ * @param text - Option text
+ * @param isSelected - Whether option is selected
+ * @param isHighlighted - Whether option is highlighted (cursor on it)
+ * @param prefix - Optional prefix (e.g., "1. ", "A. ")
+ */
+export declare function renderOption(text: string, isSelected: boolean, isHighlighted: boolean, prefix?: string): void;
+/**
+ * Render input prompt
+ * @param prompt - Prompt text
+ * @param value - Current input value
+ * @param showCursor - Whether to show cursor
+ */
+export declare function renderInputPrompt(prompt: string, value: string, showCursor?: boolean): void;
+/**
+ * Render hints
+ * @param hints - Array of hint strings
+ */
+export declare function renderHints(hints: string[]): void;
+/**
+ * Render a separator line
+ * @param char - Character to use for separator
+ * @param width - Width of separator (default: terminal width)
+ */
+export declare function renderSeparator(char?: string, width?: number): void;
+/**
+ * Render a message with icon
+ * @param type - Message type (success, error, warning, info, question)
+ * @param message - Message text
+ */
+export declare function renderMessage(type: 'success' | 'error' | 'warning' | 'info' | 'question', message: string): void;
+/**
+ * Render progress indicator
+ * @param steps - Array of step names
+ * @param currentStep - Index of current step
+ */
+export declare function renderProgress(steps: string[], currentStep: number): void;
+/**
+ * Render a box with content
+ * @param content - Array of content lines
+ * @param title - Optional title
+ * @param width - Box width (default: auto)
+ */
+export declare function renderBox(content: string[], title?: string, width?: number): void;
+/**
+ * Count lines in rendered output
+ * @param text - Text to count lines in
+ * @returns Number of lines
+ */
+export declare function countLines(text: string): number;
+/**
+ * Pad text to width
+ * @param text - Text to pad
+ * @param width - Target width
+ * @param align - Alignment (left, center, right)
+ * @returns Padded text
+ */
+export declare function padText(text: string, width: number, align?: 'left' | 'center' | 'right'): string;

package/dist/core/renderer.js

@@ -0,0 +1,217 @@
+"use strict";
+/**
+ * Base rendering functions for CLI Menu Kit
+ * Provides utilities for rendering menu components
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderBlankLines = renderBlankLines;
+exports.renderHeader = renderHeader;
+exports.renderOption = renderOption;
+exports.renderInputPrompt = renderInputPrompt;
+exports.renderHints = renderHints;
+exports.renderSeparator = renderSeparator;
+exports.renderMessage = renderMessage;
+exports.renderProgress = renderProgress;
+exports.renderBox = renderBox;
+exports.countLines = countLines;
+exports.padText = padText;
+const colors_js_1 = require("./colors.js");
+const terminal_js_1 = require("./terminal.js");
+/**
+ * Render a blank line
+ * @param count - Number of blank lines (default: 1)
+ */
+function renderBlankLines(count = 1) {
+    for (let i = 0; i < count; i++) {
+        (0, terminal_js_1.writeLine)('');
+    }
+}
+/**
+ * Render a header
+ * @param text - Header text
+ * @param color - Optional color
+ */
+function renderHeader(text, color) {
+    if (color) {
+        (0, terminal_js_1.writeLine)(`${color}${text}${colors_js_1.colors.reset}`);
+    }
+    else {
+        (0, terminal_js_1.writeLine)(text);
+    }
+}
+/**
+ * Render an option line
+ * @param text - Option text
+ * @param isSelected - Whether option is selected
+ * @param isHighlighted - Whether option is highlighted (cursor on it)
+ * @param prefix - Optional prefix (e.g., "1. ", "A. ")
+ */
+function renderOption(text, isSelected, isHighlighted, prefix) {
+    let line = '';
+    // Add cursor indicator if highlighted
+    if (isHighlighted) {
+        line += `${colors_js_1.colors.cyan}❯ ${colors_js_1.colors.reset}`;
+    }
+    else {
+        line += '  ';
+    }
+    // Add checkbox for multi-select
+    if (isSelected !== undefined && typeof isSelected === 'boolean') {
+        line += isSelected ? `${colors_js_1.colors.green}◉${colors_js_1.colors.reset} ` : `${colors_js_1.colors.dim}○${colors_js_1.colors.reset} `;
+    }
+    // Add prefix if provided
+    if (prefix) {
+        line += `${colors_js_1.colors.dim}${prefix}${colors_js_1.colors.reset}`;
+    }
+    // Add option text
+    if (isHighlighted) {
+        line += `${colors_js_1.colors.cyan}${text}${colors_js_1.colors.reset}`;
+    }
+    else {
+        line += text;
+    }
+    (0, terminal_js_1.writeLine)(line);
+}
+/**
+ * Render input prompt
+ * @param prompt - Prompt text
+ * @param value - Current input value
+ * @param showCursor - Whether to show cursor
+ */
+function renderInputPrompt(prompt, value, showCursor = false) {
+    let line = `  ${colors_js_1.colors.dim}${prompt}${colors_js_1.colors.reset} `;
+    if (value) {
+        line += `${colors_js_1.colors.cyan}${value}${colors_js_1.colors.reset}`;
+    }
+    if (showCursor) {
+        line += `${colors_js_1.colors.cyan}_${colors_js_1.colors.reset}`;
+    }
+    (0, terminal_js_1.writeLine)(line);
+}
+/**
+ * Render hints
+ * @param hints - Array of hint strings
+ */
+function renderHints(hints) {
+    if (hints.length === 0)
+        return;
+    const hintLine = `  ${colors_js_1.colors.dim}${hints.join(' • ')}${colors_js_1.colors.reset}`;
+    (0, terminal_js_1.writeLine)(hintLine);
+}
+/**
+ * Render a separator line
+ * @param char - Character to use for separator
+ * @param width - Width of separator (default: terminal width)
+ */
+function renderSeparator(char = '─', width) {
+    const termWidth = process.stdout.columns || 80;
+    const sepWidth = width || termWidth;
+    (0, terminal_js_1.writeLine)(char.repeat(sepWidth));
+}
+/**
+ * Render a message with icon
+ * @param type - Message type (success, error, warning, info, question)
+ * @param message - Message text
+ */
+function renderMessage(type, message) {
+    let icon = '';
+    let color = colors_js_1.colors.reset;
+    switch (type) {
+        case 'success':
+            icon = '✓';
+            color = colors_js_1.colors.green;
+            break;
+        case 'error':
+            icon = '✗';
+            color = colors_js_1.colors.red;
+            break;
+        case 'warning':
+            icon = '⚠';
+            color = colors_js_1.colors.yellow;
+            break;
+        case 'info':
+            icon = 'ℹ';
+            color = colors_js_1.colors.blue;
+            break;
+        case 'question':
+            icon = '?';
+            color = colors_js_1.colors.yellow;
+            break;
+    }
+    (0, terminal_js_1.writeLine)(`${color}${icon}${colors_js_1.colors.reset} ${message}`);
+}
+/**
+ * Render progress indicator
+ * @param steps - Array of step names
+ * @param currentStep - Index of current step
+ */
+function renderProgress(steps, currentStep) {
+    const parts = [];
+    steps.forEach((step, index) => {
+        if (index === currentStep) {
+            parts.push(`${colors_js_1.colors.cyan}${step}${colors_js_1.colors.reset}`);
+        }
+        else if (index < currentStep) {
+            parts.push(step);
+        }
+        else {
+            parts.push(`${colors_js_1.colors.dim}${step}${colors_js_1.colors.reset}`);
+        }
+    });
+    (0, terminal_js_1.writeLine)(`  ${parts.join(` ${colors_js_1.colors.dim}→${colors_js_1.colors.reset} `)}`);
+}
+/**
+ * Render a box with content
+ * @param content - Array of content lines
+ * @param title - Optional title
+ * @param width - Box width (default: auto)
+ */
+function renderBox(content, title, width) {
+    const termWidth = process.stdout.columns || 80;
+    const boxWidth = width || Math.min(termWidth - 4, 60);
+    // Top border
+    (0, terminal_js_1.writeLine)(`╭${'─'.repeat(boxWidth - 2)}╮`);
+    // Title if provided
+    if (title) {
+        const padding = Math.floor((boxWidth - title.length - 2) / 2);
+        (0, terminal_js_1.writeLine)(`│${' '.repeat(padding)}${title}${' '.repeat(boxWidth - padding - title.length - 2)}│`);
+        (0, terminal_js_1.writeLine)(`│${' '.repeat(boxWidth - 2)}│`);
+    }
+    // Content
+    content.forEach(line => {
+        const padding = boxWidth - line.length - 4;
+        (0, terminal_js_1.writeLine)(`│  ${line}${' '.repeat(padding)}│`);
+    });
+    // Bottom border
+    (0, terminal_js_1.writeLine)(`╰${'─'.repeat(boxWidth - 2)}╯`);
+}
+/**
+ * Count lines in rendered output
+ * @param text - Text to count lines in
+ * @returns Number of lines
+ */
+function countLines(text) {
+    return text.split('\n').length;
+}
+/**
+ * Pad text to width
+ * @param text - Text to pad
+ * @param width - Target width
+ * @param align - Alignment (left, center, right)
+ * @returns Padded text
+ */
+function padText(text, width, align = 'left') {
+    if (text.length >= width)
+        return text;
+    const padding = width - text.length;
+    switch (align) {
+        case 'left':
+            return text + ' '.repeat(padding);
+        case 'right':
+            return ' '.repeat(padding) + text;
+        case 'center':
+            const leftPad = Math.floor(padding / 2);
+            const rightPad = padding - leftPad;
+            return ' '.repeat(leftPad) + text + ' '.repeat(rightPad);
+    }
+}

package/dist/core/terminal.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Terminal control utilities for CLI Menu Kit
+ * Handles cursor movement, screen clearing, and terminal state
+ */
+/**
+ * Terminal state tracking
+ */
+export interface TerminalState {
+    stdin: NodeJS.ReadStream;
+    renderedLines: number;
+    isRawMode: boolean;
+}
+/**
+ * Initialize terminal for interactive mode
+ * @returns Terminal state object
+ */
+export declare function initTerminal(): TerminalState;
+/**
+ * Restore terminal to normal mode
+ * @param state - Terminal state
+ */
+export declare function restoreTerminal(state: TerminalState): void;
+/**
+ * Clear the current menu display
+ * @param state - Terminal state
+ */
+export declare function clearMenu(state: TerminalState): void;
+/**
+ * Clear a specific number of lines
+ * @param lines - Number of lines to clear
+ */
+export declare function clearLines(lines: number): void;
+/**
+ * Move cursor up by N lines
+ * @param lines - Number of lines to move up
+ */
+export declare function moveCursorUp(lines: number): void;
+/**
+ * Move cursor down by N lines
+ * @param lines - Number of lines to move down
+ */
+export declare function moveCursorDown(lines: number): void;
+/**
+ * Move cursor to beginning of line
+ */
+export declare function moveCursorToLineStart(): void;
+/**
+ * Clear current line
+ */
+export declare function clearCurrentLine(): void;
+/**
+ * Hide cursor
+ */
+export declare function hideCursor(): void;
+/**
+ * Show cursor
+ */
+export declare function showCursor(): void;
+/**
+ * Write text without newline
+ * @param text - Text to write
+ */
+export declare function write(text: string): void;
+/**
+ * Write text with newline
+ * @param text - Text to write
+ */
+export declare function writeLine(text: string): void;
+/**
+ * Get terminal width
+ * @returns Terminal width in columns
+ */
+export declare function getTerminalWidth(): number;
+/**
+ * Get terminal height
+ * @returns Terminal height in rows
+ */
+export declare function getTerminalHeight(): number;
+/**
+ * Clear entire screen
+ */
+export declare function clearScreen(): void;
+/**
+ * Exit with cleanup and goodbye message
+ * @param state - Terminal state
+ * @param onData - Data listener to remove
+ * @param showGoodbyeFn - Function to show goodbye message
+ */
+export declare function exitWithGoodbye(state: TerminalState, onData: (key: string) => void, showGoodbyeFn: () => void): void;

package/dist/core/terminal.js

@@ -0,0 +1,170 @@
+"use strict";
+/**
+ * Terminal control utilities for CLI Menu Kit
+ * Handles cursor movement, screen clearing, and terminal state
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initTerminal = initTerminal;
+exports.restoreTerminal = restoreTerminal;
+exports.clearMenu = clearMenu;
+exports.clearLines = clearLines;
+exports.moveCursorUp = moveCursorUp;
+exports.moveCursorDown = moveCursorDown;
+exports.moveCursorToLineStart = moveCursorToLineStart;
+exports.clearCurrentLine = clearCurrentLine;
+exports.hideCursor = hideCursor;
+exports.showCursor = showCursor;
+exports.write = write;
+exports.writeLine = writeLine;
+exports.getTerminalWidth = getTerminalWidth;
+exports.getTerminalHeight = getTerminalHeight;
+exports.clearScreen = clearScreen;
+exports.exitWithGoodbye = exitWithGoodbye;
+/**
+ * Initialize terminal for interactive mode
+ * @returns Terminal state object
+ */
+function initTerminal() {
+    const stdin = process.stdin;
+    // Enable raw mode for character-by-character input
+    stdin.setRawMode(true);
+    stdin.resume();
+    stdin.setEncoding('utf8');
+    // Hide cursor
+    process.stdout.write('\x1b[?25l');
+    return {
+        stdin,
+        renderedLines: 0,
+        isRawMode: true
+    };
+}
+/**
+ * Restore terminal to normal mode
+ * @param state - Terminal state
+ */
+function restoreTerminal(state) {
+    if (state.isRawMode) {
+        state.stdin.setRawMode(false);
+        state.isRawMode = false;
+    }
+    // Show cursor
+    process.stdout.write('\x1b[?25h');
+    state.stdin.pause();
+}
+/**
+ * Clear the current menu display
+ * @param state - Terminal state
+ */
+function clearMenu(state) {
+    if (state.renderedLines > 0) {
+        // Move cursor up to the start of the menu
+        process.stdout.write(`\x1b[${state.renderedLines}A`);
+        // Clear from cursor to end of screen
+        process.stdout.write('\x1b[J');
+        state.renderedLines = 0;
+    }
+}
+/**
+ * Clear a specific number of lines
+ * @param lines - Number of lines to clear
+ */
+function clearLines(lines) {
+    if (lines > 0) {
+        process.stdout.write(`\x1b[${lines}A`);
+        process.stdout.write('\x1b[J');
+    }
+}
+/**
+ * Move cursor up by N lines
+ * @param lines - Number of lines to move up
+ */
+function moveCursorUp(lines) {
+    if (lines > 0) {
+        process.stdout.write(`\x1b[${lines}A`);
+    }
+}
+/**
+ * Move cursor down by N lines
+ * @param lines - Number of lines to move down
+ */
+function moveCursorDown(lines) {
+    if (lines > 0) {
+        process.stdout.write(`\x1b[${lines}B`);
+    }
+}
+/**
+ * Move cursor to beginning of line
+ */
+function moveCursorToLineStart() {
+    process.stdout.write('\r');
+}
+/**
+ * Clear current line
+ */
+function clearCurrentLine() {
+    process.stdout.write('\r\x1b[K');
+}
+/**
+ * Hide cursor
+ */
+function hideCursor() {
+    process.stdout.write('\x1b[?25l');
+}
+/**
+ * Show cursor
+ */
+function showCursor() {
+    process.stdout.write('\x1b[?25h');
+}
+/**
+ * Write text without newline
+ * @param text - Text to write
+ */
+function write(text) {
+    process.stdout.write(text);
+}
+/**
+ * Write text with newline
+ * @param text - Text to write
+ */
+function writeLine(text) {
+    process.stdout.write(text + '\n');
+}
+/**
+ * Get terminal width
+ * @returns Terminal width in columns
+ */
+function getTerminalWidth() {
+    return process.stdout.columns || 80;
+}
+/**
+ * Get terminal height
+ * @returns Terminal height in rows
+ */
+function getTerminalHeight() {
+    return process.stdout.rows || 24;
+}
+/**
+ * Clear entire screen
+ */
+function clearScreen() {
+    process.stdout.write('\x1b[2J\x1b[H');
+}
+/**
+ * Exit with cleanup and goodbye message
+ * @param state - Terminal state
+ * @param onData - Data listener to remove
+ * @param showGoodbyeFn - Function to show goodbye message
+ */
+function exitWithGoodbye(state, onData, showGoodbyeFn) {
+    // Remove listener
+    state.stdin.removeListener('data', onData);
+    // Clear menu
+    clearMenu(state);
+    // Restore terminal
+    restoreTerminal(state);
+    // Show goodbye message
+    showGoodbyeFn();
+    // Exit
+    process.exit(0);
+}

package/dist/features/commands.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Commands - Command handling system
+ * Handles special commands like /quit, /help, /clear, /back
+ */
+/**
+ * Command handler function type
+ */
+export type CommandHandler = (args?: string[]) => boolean | void;
+/**
+ * Register a custom command
+ * @param command - Command name (without /)
+ * @param handler - Command handler function
+ * @param description - Command description
+ */
+export declare function registerCommand(command: string, handler: CommandHandler, description: string): void;
+/**
+ * Unregister a custom command
+ * @param command - Command name (without /)
+ */
+export declare function unregisterCommand(command: string): void;
+/**
+ * Clear all custom commands
+ */
+export declare function clearCustomCommands(): void;
+/**
+ * Check if input is a command
+ * @param input - Input string
+ * @returns True if input is a command
+ */
+export declare function isCommand(input: string): boolean;
+/**
+ * Parse command from input
+ * @param input - Input string
+ * @returns Command name and args, or null if not a command
+ */
+export declare function parseCommand(input: string): {
+    command: string;
+    args: string[];
+} | null;
+/**
+ * Handle a command
+ * @param input - Input string
+ * @returns Command result (true = handled and should exit/go back, false = continue, undefined = not a command)
+ */
+export declare function handleCommand(input: string): boolean | undefined;
+/**
+ * Get all available commands
+ * @returns Array of command names with descriptions
+ */
+export declare function getAvailableCommands(): Array<{
+    command: string;
+    description: string;
+}>;
+/**
+ * Show help for all commands
+ */
+export declare function showCommandHelp(): void;