Enquirer交互式命令行工具使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00130/article/details/148442997

Enquirer交互式命令行工具使用指南

enquirer Stylish, intuitive and user-friendly prompts, for Node.js. Used by eslint, webpack, yarn, pm2, pnpm, RedwoodJS, FactorJS, salesforce, Cypress, Google Lighthouse, Generate, tencent cloudbase, lint-staged, gluegun, hygen, hardhat, AWS Amplify, GitHub Actions Toolkit, @airbnb/nimbus, and many others! Please follow Enquirer's author: https://github.com/jonschlinkert 项目地址: https://gitcode.com/gh_mirrors/en/enquirer

什么是Enquirer

Enquirer是一个功能强大的Node.js交互式命令行工具库，它可以帮助开发者轻松创建各种类型的命令行交互界面。通过Enquirer，开发者可以快速实现用户输入、选择、确认等交互功能，极大提升命令行工具的用户体验。

基础使用方法

单个问题交互

最简单的使用方式是通过prompt方法传入一个问题对象：

const { prompt } = require('enquirer');

async function getUserInfo() {
  const response = await prompt({
    type: 'input',       // 输入类型
    name: 'username',    // 返回结果的键名
    message: '请输入您的用户名:'  // 提示信息
  });

  console.log(response); // 输出: { username: '用户输入的值' }
}

getUserInfo();

注意：使用await需要在async函数中运行。

多个问题连续交互

通过传入问题对象数组，可以实现多个问题的连续交互：

const response = await prompt([
  {
    type: 'input',
    name: 'name',
    message: '您的姓名是?'
  },
  {
    type: 'input',
    name: 'email',
    message: '您的电子邮箱是?'
  }
]);

console.log(response); 
// 输出示例: { name: '张三', email: 'zhangsan@example.com' }

进阶使用方式

1. 直接使用内置Prompt类

Enquirer提供了多种内置的Prompt类，可以直接实例化使用：

const { Confirm } = require('enquirer');

const prompt = new Confirm({
  name: 'agree',
  message: '您是否同意条款?'
});

prompt.run()
  .then(answer => console.log('结果:', answer));

这种方式适合需要更精细控制的情况。

2. 通过options对象配置

更简洁的方式是直接传入配置对象：

const { prompt } = require('enquirer');

prompt({
  type: 'confirm',
  name: 'subscribe',
  message: '是否订阅我们的新闻?'
})
.then(answer => console.log('选择结果:', answer));