Node-Choice

Node-Choice

Node-Choice 是一个轻量级的命令行交互工具，支持选择模式（从预定义选项中选择）和输入模式（用户自由输入）。它旨在简化命令行交互的实现，适用于各种 Node.js 项目。

功能特性

1. 选择模式：

   • 支持从预定义选项中选择。
   • 提供默认选中项，支持用户输入编号或直接回车选择默认值。

2. 输入模式：

   • 当未提供选项时，切换为自由输入模式，允许用户输入任意内容。

3. TypeScript 支持：

   • 完全基于 TypeScript 实现，确保类型安全和更好的开发体验。

4. 兼容性：

   • 同时支持 ESM 和 CommonJS 模块格式，便于在不同环境中使用。

5. 简单易用：

   • 提供直观的 API，开箱即用，适合快速集成到任何项目中。

---

安装

通过 npm 安装：

npm install node-choice

---

使用方法

1. 选择模式

当提供选项数组时，工具会进入选择模式，用户可以从选项中选择一个。

示例代码：

import { choice } from 'node-choice';// 带选项的选择模式
const result = await choice("What is your favorite color?", ["Red", "Green", "Blue"], 1);
console.log(`选择结果: 索引 ${result.index}，值为: ${result.value}`);

输出示例：

What is your favorite color?1. Red
→ 2. Green3. Blue
请输入选项编号 (默认: 2): 
选择结果: 索引 1，值为: Green

---

2. 输入模式

当未提供选项数组时，工具会进入输入模式，允许用户自由输入。

示例代码：

import { choice } from 'node-choice';// 输入模式
const result = await choice("请输入你的邮箱:");
console.log(`输入结果: ${result.value}`);

输出示例：

请输入你的邮箱:
请输入内容: [e-mail]
输入结果: [e-mail]

---