Qoa入门指南：如何快速构建交互式命令行应用-程序员充电站

Qoa入门指南：如何快速构建交互式命令行应用

【免费下载链接】qoaMinimal interactive command-line prompts项目地址: https://gitcode.com/gh_mirrors/qo/qoa

Qoa是一个轻量级的交互式命令行提示库，全称为"Minimal interactive command-line prompts"。它允许开发者通过简单直观的方式接收用户输入，支持多种类型的交互式提示，且无需任何外部依赖。无论是构建命令行工具、脚本还是应用程序，Qoa都能帮助你轻松实现专业的用户交互体验。

为什么选择Qoa？✨

Qoa作为一款专注于命令行交互的工具，具有以下核心优势：

零依赖：无需安装额外的包，轻量级设计确保快速加载和执行
丰富的交互类型：提供7种不同的提示类型，满足各种输入需求
简洁API：使用直观的语法，快速集成到任何Node.js项目中
高度可定制：支持自定义前缀、查询样式和交互行为
异步支持：完全基于async/await设计，轻松处理异步流程

图1：Qoa提供的多样化交互式命令行界面展示

快速开始：安装与基础使用

安装Qoa

通过npm或yarn可以轻松安装Qoa：

# 使用npm npm install qoa # 使用yarn yarn add qoa

如果你想直接使用源码，可以克隆仓库：

git clone https://gitcode.com/gh_mirrors/qo/qoa cd qoa npm install

第一个Qoa应用

创建一个简单的交互式提示程序非常简单。以下是一个基本示例，演示如何获取用户的用户名和密码：

const qoa = require('qoa'); // 定义要显示的提示数组 const prompts = [ { type: 'input', query: '请输入您的用户名:', handle: 'username' }, { type: 'secure', query: '请输入您的密码:', handle: 'password' } ]; // 显示提示并处理结果 qoa.prompt(prompts).then(answers => { console.log('用户输入结果:', answers); //=> { username: '用户输入的名字', password: '用户输入的密码' } });

图2：Qoa基本输入和安全密码提示的使用效果

探索Qoa的7种交互式提示类型

Qoa提供了7种不同的提示类型，每种类型都针对特定的用户交互场景优化。

1. 确认提示（Confirm Prompt）

用于获取用户的简单确认或否定回答：

const confirmPrompt = { type: 'confirm', query: '是否要保存更改?', handle: 'saveChanges', accept: 'Y', // 确认输入 deny: 'n' // 否定输入 }; qoa.confirm(confirmPrompt).then(result => { console.log('用户选择:', result.saveChanges ? '保存' : '不保存'); });

图3：Qoa确认提示允许用户通过简单输入确认或拒绝操作

2. 隐藏输入提示（Hidden Prompt）

用于输入需要完全隐藏的敏感信息，输入内容不会显示在屏幕上：

const hiddenPrompt = { type: 'hidden', query: '[sudo] 管理员密码:', handle: 'sudoPassword' }; qoa.hidden(hiddenPrompt).then(result => { console.log('已收到密码输入'); });

图4：隐藏输入提示不显示任何输入内容，适用于高度敏感信息

3. 文本输入提示（Input Prompt）

用于接收用户的自由文本输入：

const inputPrompt = { type: 'input', query: '请输入您的电子邮箱:', handle: 'email' }; qoa.input(inputPrompt).then(result => { console.log('您的邮箱是:', result.email); });

图5：文本输入提示允许用户输入任意文本内容

4. 交互式菜单提示（Interactive Prompt）

创建可导航的选项菜单，用户可以使用箭头键或j/k键选择选项：

const interactivePrompt = { type: 'interactive', query: '您最喜欢的编程语言是什么?', handle: 'favoriteLanguage', symbol: '→', // 自定义导航符号 menu: [ 'JavaScript', 'Python', 'Go', 'Rust', 'TypeScript' ] }; qoa.interactive(interactivePrompt).then(result => { console.log('您选择了:', result.favoriteLanguage); });

图6：交互式菜单允许用户通过键盘导航选择选项

5. 按键选择提示（Keypress Prompt）

创建数字键选择菜单，用户通过按1-9数字键快速选择选项：

const keypressPrompt = { type: 'keypress', query: '您对本次服务的满意度如何?', handle: 'satisfaction', menu: [ '非常不满意', '不满意', '一般', '满意', '非常满意' ] }; qoa.keypress(keypressPrompt).then(result => { console.log('满意度评价:', result.satisfaction); });

图7：按键选择提示允许用户通过数字键快速选择选项

6. 测验提示（Quiz Prompt）

创建带有正确答案的测验，可随机显示选项并判断用户答案是否正确：

const quizPrompt = { type: 'quiz', query: 'Node.js的创始人是谁?', handle: 'nodeFounder', answer: 'Ryan Dahl', // 正确答案 symbol: '?', amount: 4, // 显示的选项数量 choices: [ 'Brendan Eich', 'Ryan Dahl', 'Guido van Rossum', 'James Gosling', 'Larry Page' ] }; qoa.quiz(quizPrompt).then(result => { console.log('您的答案:', result.nodeFounder.answer); console.log('是否正确:', result.nodeFounder.isCorrect ? '是' : '否'); });

图8：测验提示可用于创建问答游戏或知识测试

7. 安全输入提示（Secure Prompt）

用于输入敏感信息，输入内容会显示为星号(*)：

const securePrompt = { type: 'secure', query: '请设置您的密码:', handle: 'userPassword' }; qoa.secure(securePrompt).then(result => { console.log('密码已设置，长度为:', result.userPassword.length); });

图9：安全输入提示将输入显示为星号，保护敏感信息

Qoa高级配置

Qoa提供了多种配置选项，让你可以自定义提示的外观和行为。

全局配置

使用config方法可以设置全局配置，影响所有提示：

// 设置全局配置 qoa.config({ prefix: '> ', // 所有提示前显示的前缀 underlineQuery: true // 是否下划线显示查询文本 });

单独配置方法

也可以使用单独的方法设置特定配置：

// 设置前缀 qoa.prefix('→ '); // 设置是否下划线查询文本 qoa.underlineQuery(true); // 清除屏幕 qoa.clearScreen();

实际应用示例：用户注册流程

以下是一个完整的用户注册流程示例，结合了多种Qoa提示类型：

const qoa = require('qoa'); async function registerUser() { qoa.clearScreen(); console.log('=== 用户注册 ===\n'); const userInfo = await qoa.prompt([ { type: 'input', query: '请输入用户名:', handle: 'username' }, { type: 'input', query: '请输入电子邮箱:', handle: 'email' }, { type: 'secure', query: '请设置密码:', handle: 'password' }, { type: 'hidden', query: '请确认密码:', handle: 'confirmPassword' }, { type: 'interactive', query: '请选择您的用户角色:', handle: 'role', menu: ['普通用户', '管理员', '访客'] }, { type: 'confirm', query: '注册信息是否正确?', handle: 'confirmRegistration' } ]); if (userInfo.confirmRegistration) { if (userInfo.password === userInfo.confirmPassword) { console.log('\n注册成功！用户信息如下:'); console.log(`用户名: ${userInfo.username}`); console.log(`邮箱: ${userInfo.email}`); console.log(`角色: ${userInfo.role}`); } else { console.log('\n错误：两次输入的密码不一致'); } } else { console.log('\n注册已取消'); } } registerUser();

这个示例展示了如何组合使用不同的提示类型，创建一个完整的用户注册流程。通过Qoa，只需几行代码就能实现专业的命令行交互体验。