{"_id":"@buureadline/buureadline","name":"@buureadline/buureadline","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@buureadline/buureadline","version":"1.0.0","description":"Colorful readline library with menu, question and choice functions for interactive CLI applications.","keywords":["readline","terminal","menu","interactive","buu-readline"],"author":{"name":"HonneyBuuModz"},"license":"MIT","main":"buuReadlineApi.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"dependencies":{},"peerDependencies":{"@buucolors/buucolors":"^1.0.0"},"peerDependenciesMeta":{"@buucolors/buucolors":{"optional":true}},"_id":"@buureadline/buureadline@1.0.0","_nodeVersion":"24.9.0","_npmVersion":"11.6.0","dist":{"integrity":"sha512-5TJ6+lQqi9UiDh58P2J6HFUwOWqTQ+7Olq6bUeKwHF56PXuzVw2ERgnGFQwnb8DTf6hZflDnmszaL5OAVFFuNw==","shasum":"3368129eaa53e3d60289060e20bda7d4aa1f90dd","tarball":"https://registry.npmjs.org/@buureadline/buureadline/-/buureadline-1.0.0.tgz","fileCount":3,"unpackedSize":19985,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBIlwTlp7jRaVJroSLKKgGQ4b9tinsddO/mA459Un9bqAiBmE5L9iXVixDAeP6gkz7kDmubQCDP28b0PRnCd+puN9w=="}]},"_npmUser":{"name":"honneybuu","email":"honneybuu.modz@gmail.com"},"directories":{},"maintainers":[{"name":"honneybuu","email":"honneybuu.modz@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/buureadline_1.0.0_1762205361263_0.7901119919954571"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-03T21:29:21.165Z","1.0.0":"2025-11-03T21:29:21.494Z","modified":"2025-11-03T21:29:21.819Z"},"maintainers":[{"name":"honneybuu","email":"honneybuu.modz@gmail.com"}],"description":"Colorful readline library with menu, question and choice functions for interactive CLI applications.","keywords":["readline","terminal","menu","interactive","buu-readline"],"author":{"name":"HonneyBuuModz"},"license":"MIT","readme":"# BuuReadline\n\n
\n \n \n \"Version\"\n \n\n \n \n \"BuuReadline\"\n \n \n \n \n \n \"NPM\n \n \n\n \n \n \"License\"\n \n\n \n \n \"JavaScript\n \n\n

\n\n

āœØ Interactive CLI Readline Library āœØ

\n

Colorful readline library with menu, question and choice functions

\n
\n\n---\n\n## šŸš€ Features\n\n
\n\n- šŸŽØ *Optional Color Support* - Integrates with @buucolors/buucolors\n- šŸ“‹ *Interactive Menus* - Numbered selection options\n- ā“ *Simple Questions* - Promise-based input prompts\n- āœ… *Yes/No Queries* - German and English input support\n- šŸŽÆ *Fallback System* - Works without color package\n- āš” *Lightweight* - Minimal dependencies\n- šŸ”— *Simple API* - Intuitive methods\n- šŸŒˆ *Automatic Color Detection* - Loads BuuColors automatically\n- šŸš« *Zero Dependencies* - Works standalone without any requirements\n\n
\n\n## šŸ“¦ Installation\n\n```bash\n# Basic installation (works standalone)\nnpm install @buureadline/buu-readline\n\n# With color support (recommended)\nnpm install @buureadline/buu-readline @buucolors/buucolors\n\n# Using yarn\nyarn add @buureadline/buu-readline @buucolors/buucolors\n\n# Using pnpm\npnpm add @buureadline/buu-readline @buucolors/buucolors\n```\n\n**Note:** BuuReadline works perfectly without any dependencies. Colors are automatically enabled if `@buucolors/buucolors` is installed, otherwise it falls back to plain text.\n\n## šŸ’” Quick Start\n\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\n// Create readline interface (with automatic color detection)\nconst rl = createBuuRl();\n\nasync function quickDemo() {\n // Simple question\n const name = await rl.question('What is your name? ');\n console.log(`Hello ${name}! šŸ‘‹`);\n\n // Interactive menu\n const choice = await rl.menu('What would you like to do?', [\n 'šŸ“‚ Open file',\n 'šŸ’¾ Save file', \n 'šŸšŖ Exit'\n ]);\n console.log(`You chose: ${choice}`);\n\n // Yes/No question\n const confirm = await rl.choose('Do you want to continue? (y/n): ');\n console.log(confirm ? 'āœ… Let\\'s go!' : 'āŒ Cancelled.');\n\n rl.close();\n}\n\nquickDemo();\n```\n\n## šŸŽØ With BuuColors (Recommended)\n\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\nconst rl = createBuuRl(); // Loads BuuColors automatically if available\n\nasync function colorfulExample() {\n // Colorful input prompts\n const project = await rl.question('šŸš€ Project name: ');\n \n // Colorful menu with options\n const framework = await rl.menu('šŸ› ļø Choose framework:', [\n 'React.js',\n 'Vue.js', \n 'Angular',\n 'Vanilla JS'\n ]);\n \n // Confirmation with colors\n const useTS = await rl.choose('šŸ“ Use TypeScript? ');\n \n console.log(`\nšŸŽ‰ Project Setup:\nšŸ“¦ Name: ${project}\nāš” Framework: ${framework} \nšŸ“˜ TypeScript: ${useTS ? 'Yes' : 'No'}\n `);\n \n rl.close();\n}\n\ncolorfulExample();\n```\n\n## šŸ”§ Without BuuColors (Plaintext)\n\nThe package works automatically without colors when `@buucolors/buucolors` is not installed:\n\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\n// Works without BuuColors - uses plaintext\nconst rl = createBuuRl();\n\nasync function plaintextExample() {\n const name = await rl.question('Enter name: ');\n \n const choice = await rl.menu('Select option:', [\n 'Option A',\n 'Option B', \n 'Option C'\n ]);\n \n const confirm = await rl.choose('Confirm? (y/n): ');\n \n console.log(`Name: ${name}, Choice: ${choice}, Confirmed: ${confirm}`);\n rl.close();\n}\n\nplaintextExample();\n```\n\n**Perfect for environments where:**\n- You don't want color dependencies\n- Running in CI/CD pipelines\n- Building lightweight CLI tools\n- Colors are not supported\n\n## šŸŽØ Custom Colors\n\nYou can define your own color functions:\n\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\n// Custom color definitions\nconst customColors = {\n gradientCmd_yellow2orange: Object.assign(\n (text) => `\\x1b[38;5;214m${text}\\x1b[0m`, \n { bold: (text) => `\\x1b[1;38;5;214m${text}\\x1b[0m` }\n ),\n cmdMagenta: Object.assign(\n (text) => `\\x1b[35m${text}\\x1b[0m`,\n { bold: (text) => `\\x1b[1;35m${text}\\x1b[0m` }\n ),\n cmdBrightMagenta: (text) => `\\x1b[95m${text}\\x1b[0m`,\n cmdRed: (text) => `\\x1b[31m${text}\\x1b[0m`\n};\n\nconst rl = createBuuRl(customColors);\n\nasync function customColorExample() {\n const answer = await rl.question('With custom colors: ');\n console.log(`Input: ${answer}`);\n rl.close();\n}\n\ncustomColorExample();\n```\n\n**Use cases for custom colors:**\n- Brand-specific color schemes\n- Terminal-specific optimizations\n- Custom styling requirements\n- Integration with other color libraries\n\n## šŸ“‹ API Reference\n\n### `createBuuRl(buuColor?): BuuReadlineInterface`\n\nCreates a new readline instance with automatic color detection.\n\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\n// Automatic color detection\nconst rl = createBuuRl();\n\n// With custom colors\nconst rl2 = createBuuRl(customColors);\n```\n\n### BuuReadlineInterface Methods\n\n#### `question(query): Promise`\nAsks a simple question and waits for input.\n\n```javascript\nconst name = await rl.question('What is your name? ');\nconst email = await rl.question('šŸ“§ Email address: ');\n```\n\n#### `menu(query, options): Promise`\nShows a numbered menu and returns the selected option.\n\n```javascript\nconst choice = await rl.menu('Choose framework:', [\n 'React.js',\n 'Vue.js',\n 'Angular'\n]);\n// Returns the selected option (e.g. \"React.js\")\n```\n\n#### `choose(query): Promise`\nAsks a yes/no question with multilingual support.\n\n```javascript\nconst confirm = await rl.choose('Continue? (y/n): ');\n// true for: j, ja, y, yes\n// false for: n, nein, no\n```\n\n#### `close(): void`\nCloses the interface and frees resources.\n\n```javascript\nrl.close(); // Always call at the end\n```\n\n## āš” Advanced Features\n\n
\n\n- āœ… *JavaScript Compatible* - Fully compatible\n- āœ… *CommonJS Module* - Standard require() syntax\n- āœ… *Automatic Color Detection* - Loads BuuColors if available\n- āœ… *Fallback System* - Plaintext without color package\n- āœ… *Multilingual Input* - German and English for yes/no\n- āœ… *Promise-based* - Modern async/await syntax\n- āœ… *Robust Validation* - Safe input handling\n- āœ… *Lightweight* - Minimal overhead\n- āœ… *Zero Dependencies* - Works completely standalone\n\n
\n\n## šŸ”„ Real-World Examples\n\n### CLI Tool Setup Wizard\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\nasync function setupWizard() {\n const rl = createBuuRl();\n \n console.log('šŸŽ‰ Setup wizard started!\\n');\n \n // Collect project information\n const projectName = await rl.question('šŸ“¦ Project name: ');\n const description = await rl.question('šŸ“ Description: ');\n \n // Select technology stack\n const frontend = await rl.menu('šŸŽØ Frontend framework:', [\n 'React.js',\n 'Vue.js', \n 'Angular',\n 'Svelte',\n 'Vanilla JS'\n ]);\n \n const backend = await rl.menu('āš™ļø Backend framework:', [\n 'Express.js',\n 'Fastify',\n 'Koa.js',\n 'NestJS',\n 'Frontend only'\n ]);\n \n // Additional features\n const useTS = await rl.choose('šŸ“˜ Use TypeScript? ');\n const useESLint = await rl.choose('šŸ” Setup ESLint? ');\n const usePrettier = await rl.choose('šŸ’„ Setup Prettier? ');\n \n // Summary\n console.log('\\nāœØ Project Configuration:');\n console.log(`ā”œā”€ šŸ“¦ Name: ${projectName}`);\n console.log(`ā”œā”€ šŸ“ Description: ${description}`);\n console.log(`ā”œā”€ šŸŽØ Frontend: ${frontend}`);\n console.log(`ā”œā”€ āš™ļø Backend: ${backend}`);\n console.log(`ā”œā”€ šŸ“˜ TypeScript: ${useTS ? 'Yes' : 'No'}`);\n console.log(`ā”œā”€ šŸ” ESLint: ${useESLint ? 'Yes' : 'No'}`);\n console.log(`ā””ā”€ šŸ’„ Prettier: ${usePrettier ? 'Yes' : 'No'}`);\n \n const confirm = await rl.choose('\\nšŸš€ Create project? ');\n console.log(confirm ? 'āœ… Creating project...' : 'āŒ Setup cancelled.');\n \n rl.close();\n}\n\nsetupWizard();\n```\n\n### Interactive CLI Menu System\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\nasync function mainMenu() {\n const rl = createBuuRl();\n \n while (true) {\n console.clear();\n console.log('šŸŒŸ Main Menu šŸŒŸ\\n');\n \n const action = await rl.menu('What would you like to do?', [\n 'šŸ“Š Show data',\n 'āœļø Edit data', \n 'šŸ—‘ļø Delete data',\n 'āš™ļø Settings',\n 'šŸšŖ Exit'\n ]);\n \n switch (action) {\n case 'šŸ“Š Show data':\n await showData(rl);\n break;\n case 'āœļø Edit data':\n await editData(rl);\n break;\n case 'šŸ—‘ļø Delete data':\n await deleteData(rl);\n break;\n case 'āš™ļø Settings':\n await settings(rl);\n break;\n case 'šŸšŖ Exit':\n const confirm = await rl.choose('Really exit? ');\n if (confirm) {\n console.log('šŸ‘‹ Goodbye!');\n rl.close();\n return;\n }\n break;\n }\n \n await rl.question('\\nāøļø Press Enter to continue...');\n }\n}\n\nasync function showData(rl) {\n console.log('\\nšŸ“Š Displaying data...');\n // Data logic here\n}\n\nasync function editData(rl) {\n const field = await rl.menu('Which field to edit?', [\n 'Name',\n 'Email',\n 'Phone'\n ]);\n const newValue = await rl.question(`New value for ${field}: `);\n console.log(`āœ… ${field} updated to \"${newValue}\".`);\n}\n\nasync function deleteData(rl) {\n const confirm = await rl.choose('āš ļø Really delete data? ');\n console.log(confirm ? 'šŸ—‘ļø Data deleted.' : 'āŒ Operation cancelled.');\n}\n\nasync function settings(rl) {\n const setting = await rl.menu('Choose setting:', [\n 'Change language',\n 'Change theme',\n 'Back'\n ]);\n console.log(`āš™ļø ${setting} selected.`);\n}\n\nmainMenu();\n```\n\n### Standalone Usage (No Dependencies)\n```javascript\nconst { createBuuRl } = require('@buureadline/buu-readline');\n\n// Works perfectly without any other packages installed\nasync function standaloneExample() {\n const rl = createBuuRl(); // No colors, pure functionality\n \n console.log('This works without any dependencies!\\n');\n \n const name = await rl.question('Enter your name: ');\n const age = await rl.question('Enter your age: ');\n \n const language = await rl.menu('Choose your preferred language:', [\n 'JavaScript',\n 'TypeScript',\n 'Python',\n 'Go',\n 'Rust'\n ]);\n \n const isExperienced = await rl.choose('Are you an experienced developer? (y/n): ');\n \n console.log('\\n--- Profile Summary ---');\n console.log(`Name: ${name}`);\n console.log(`Age: ${age}`);\n console.log(`Preferred Language: ${language}`);\n console.log(`Experience Level: ${isExperienced ? 'Experienced' : 'Beginner'}`);\n \n rl.close();\n}\n\nstandaloneExample();\n```\n\n## šŸ“‹ Package Contents\n\n- šŸ“ƒ `buuReadlineApi.js` - Main API file\n- šŸ“– `README.md` - This beautiful documentation\n- šŸ“œ `package.json` - Package configuration\n\n## šŸ¤ Contributing\n\nWe welcome contributions! You can:\n\n- šŸ› Report bugs\n- šŸ’” Suggest new features \n- šŸ”§ Submit improvements\n- šŸŒŸ Rate and share the package\n\n## šŸŽÆ Use Cases\n\n**Perfect for:**\n- šŸ› ļø CLI tool creation\n- ļæ½ Interactive setup wizards\n- šŸŽ® Terminal-based games\n- šŸ“Š Data collection scripts\n- āš™ļø Configuration managers\n- šŸ”§ Development tools\n- šŸ“ Survey applications\n- šŸŽØ Interactive demonstrations\n\n## šŸ“„ License\n\n
\n\n**MIT License** - Free and Open Source\n\nThis project is licensed under the MIT License, which means you are free to:\n- āœ… *Use* - Use this library in personal and commercial projects\n- āœ… *Modify* - Change and customize the code to fit your needs \n- āœ… *Distribute* - Share and redistribute the library\n- āœ… *Private Use* - Use in private projects without restrictions\n- āœ… *Commercial Use* - Use in commercial applications and products\n\nThe only requirement is to include the original copyright notice and license terms.\n\n
\n\n## šŸŒ Connect with Us\n\n
\n \n \"WhatsApp\n \n \n \n \"Telegram\n \n\n \n \"Instagram\n \n
\n\n---\n\n
\n

\n Made with šŸ’œ by HonneyBuuModz\n

\n \n

\n šŸŒŸ If this project helped you, please consider giving it a star! šŸŒŸ\n

\n
\n\n
\n \"Built\n
","readmeFilename":"README.md","_rev":"1-f9e31464e4dfd2ff44b573456c988d8c"}