Enquirer 现代化的交互式命令行工具库

662 字

3 分钟

Enquirer 现代化的交互式命令行工具库

2025-06-30

博客

nodejs

前言#

在现代前端开发中，命令行工具 (CLI) 已经成为开发者日常工作中不可或缺的一部分。而如何让CLI工具更加友好、直观，提供良好的用户体验？交互式命令行界面是关键。这里将介绍如何使用Enquirer 来构建交互式命令行。

Enquirer 是一个现代化、直观且用户友好的命令行提示工具库。它提供了简洁的 API 、现代化的界面以及更强大的交互功能。

Github

开始#

安装#

1
npm install enquirer
2
# or
3
yarn yarn add enquirer

使用#

1.基本选择提示#

1
const { Select } = require("enquirer");
2

3
const prompt = new Select({
4
  name: "color",
5
  message: "选择你喜欢的颜色",
6
  choices: ["红色", "黄色", "蓝色"],
7
});
8

9
prompt
10
  .run()
11
  .then((answer) => console.log("你选择了:", answer))
12
  .catch(console.error);

2.多选提示#

1
const { MultiSelect } = require('enquirer');
2

3
const prompt = new MultiSelect({
4
  name: 'foods',
5
  message: '选择你喜欢的食物(按空格选择)',
6
  choices: [
7
    { name: 'pizza', value: '披萨' },
8
    { name: 'burger', value: '汉堡' },
9
    { name: 'sushi', value: '寿司' },
10
    { name: 'noodles', value: '面条' }
11
  ]
12
});
13

14
prompt.run()
15
  .then(answers => console.log('你选择了:', answers))
16
  .catch(console.error);

3.输入框提示#

1
const { Input } = require('enquirer');
2

3
const prompt = new Input({
4
  name: 'username',
5
  message: '请输入你的用户名'
6
});
7

8
prompt.run()
9
  .then(answer => console.log('用户名:', answer))
10
  .catch(console.error);

4.表单输入#

1
const { Form } = require('enquirer');
2

3
const prompt = new Form({
4
  name: 'user',
5
  message: '请填写用户信息',
6
  choices: [
7
    { name: 'firstName', message: '名' },
8
    { name: 'lastName', message: '姓' },
9
    { name: 'email', message: '邮箱' }
10
  ]
11
});
12

13
prompt.run()
14
  .then(value => console.log('用户信息:', value))
15
  .catch(console.error);

5.自动补全#

1
const { AutoComplete } = require('enquirer');
2

3
const prompt = new AutoComplete({
4
  name: 'flavor',
5
  message: '选择你喜欢的编程语言(输入可过滤)',
6
  limit: 10,
7
  initial: 2,
8
  choices: [
9
    'JavaScript',
10
    'TypeScript',
11
    'Python',
12
    'Java',
13
    'C++',
14
    'C#',
15
    'Go',
16
    'Ruby',
17
    'Swift',
18
    'Kotlin'
19
  ]
20
});
21

22
prompt.run()
23
  .then(answer => console.log('你选择了:', answer))
24
  .catch(console.error);

6.自定义验证#

1
const { Input } = require('enquirer');
2

3
const prompt = new Input({
4
  name: 'age',
5
  message: '请输入你的年龄',
6
  validate(value) {
7
    if (isNaN(value)) return '请输入数字';
8
    if (value < 18) return '必须年满18岁';
9
    return true;
10
  }
11
});
12

13
prompt.run()
14
  .then(answer => console.log('年龄:', answer))
15
  .catch(console.error);

构建一个 Cli 项目#

在这里我们使用 prompt 函数构建：

1
const { prompt } = require("enquirer");
2

3
async function initProject() {
4
  const answers = await prompt([
5
    {
6
      type: "select",
7
      name: "type",
8
      message: "选择框架",
9
      choices: ["Vue", "React"],
10
    },
11
    {
12
      type: "input",
13
      name: "name",
14
      message: "输入项目名称",
15
      validate: (value) => (value.trim() ? true : "项目名称不能为空"),
16
    },
17
    {
18
      type: "confirm",
19
      name: "typescript",
20
      message: "确定要安装吗?",
21
    },
22
    {
23
      type: "multiselect",
24
      name: "features",
25
      message: "选择额外功能(按空格选择)",
26
      choices: [
27
        { name: "eslint", message: "ESLint代码检查" },
28
        { name: "prettier", message: "Prettier代码格式化" },
29
        { name: "tests", message: "单元测试" },
30
        { name: "ci", message: "CI配置" },
31
      ],
32
    },
33
  ]);
34
  console.log("\n配置汇总:");
35
  console.log("项目类型:", answers.type);
36
  console.log("项目名称:", answers.name);
37
  console.log("使用TypeScript:", answers.typescript ? "是" : "否");
38
  console.log("额外功能:", answers.features.join(", "));
39
}
40

41
initProject().catch(console.error);