Inquirer.js：交互式命令行工具

2025-04-22 08:30:11

在现代软件开发中，命令行工具（CLI）扮演着至关重要的角色。它们不仅能够提高开发效率，还能够简化复杂的操作流程。Inquirer.js作为一款强大的交互式命令行工具，能够帮助开发者创建用户友好的命令行界面。Inquirer.js支持多种输入类型，包括文本输入、选择列表、确认框等，并提供了丰富的功能，如输入验证、自定义提示符和异步操作。本文将带领读者深入了解Inquirer.js的各项特性，从基础配置到高级功能，全面解析这个优秀的命令行工具。

Inquirer.js Logo

Inquirer.js简介

Inquirer.js是一个用于Node.js的交互式命令行工具，能够帮助开发者创建用户友好的命令行界面。它支持多种输入类型，包括文本输入、选择列表、确认框等，并提供了丰富的功能，如输入验证、自定义提示符和异步操作。以下是Inquirer.js的一些关键特性：

多种输入类型

Inquirer.js支持多种输入类型，包括文本输入、选择列表、确认框、密码输入、编辑器输入等。这些输入类型能够满足各种开发需求，帮助开发者创建复杂的命令行界面。

输入验证

Inquirer.js提供了强大的输入验证功能，能够确保用户输入的数据符合预期。开发者可以自定义验证函数，根据具体需求进行验证。

自定义提示符

Inquirer.js支持自定义提示符，能够根据具体需求调整提示符的外观和行为。开发者可以使用自定义的提示符来提升用户体验。

异步操作

Inquirer.js支持异步操作，能够处理复杂的异步逻辑。开发者可以使用异步函数来处理输入数据，确保命令行工具的高效性和可靠性。

插件扩展

Inquirer.js提供了丰富的插件生态系统，帮助开发者扩展和定制命令行工具的功能。开发者可以根据具体需求选择合适的插件，满足各种开发场景。

安装与初始化

要开始使用Inquirer.js，首先需要安装相应的库。Inquirer.js可以通过npm进行安装。以下是安装Inquirer.js的基本步骤：

  1. 安装Node.js：确保系统中已经安装了Node.js。建议使用Node.js 12.x或更高版本。

  2. 安装Inquirer.js：打开终端或命令提示符，运行以下命令安装Inquirer.js：

    npm install inquirer

  3. 导入库：在Node.js文件中导入Inquirer.js库：

    const inquirer = require('inquirer');

  4. 创建问题：创建一个包含问题的数组，并使用inquirer.prompt方法进行提示。以下是创建问题的示例：

    const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
  },
  {
    type: 'password',
    name: 'password',
    message: 'What is your password?',
    mask: '*',
  },
  {
    type: 'confirm',
    name: 'confirm',
    message: 'Are you sure?',
    default: true,
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Answers:', answers);
});

问题定义

Inquirer.js支持多种输入类型，包括文本输入、选择列表、确认框等。以下是问题定义的一些关键内容：

文本输入

文本输入是最基本的输入类型，用于获取用户的文本输入。以下是文本输入的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
});

密码输入

密码输入用于获取用户的密码输入，并且输入内容会被隐藏。以下是密码输入的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'password',
    name: 'password',
    message: 'What is your password?',
    mask: '*',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Password:', answers.password);
});

确认框

确认框用于获取用户的确认输入，返回布尔值。以下是确认框的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'confirm',
    name: 'confirm',
    message: 'Are you sure?',
    default: true,
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Confirm:', answers.confirm);
});

选择列表

选择列表用于获取用户的单选输入，返回选中的值。以下是选择列表的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'list',
    name: 'color',
    message: 'What is your favorite color?',
    choices: ['Red', 'Green', 'Blue'],
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Color:', answers.color);
});

复选框

复选框用于获取用户的多选输入，返回选中的值数组。以下是复选框的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'checkbox',
    name: 'colors',
    message: 'What are your favorite colors?',
    choices: ['Red', 'Green', 'Blue'],
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Colors:', answers.colors);
});

编辑器输入

编辑器输入用于获取用户的多行文本输入，返回输入的内容。以下是编辑器输入的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'editor',
    name: 'bio',
    message: 'Please write a short bio about yourself:',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Bio:', answers.bio);
});

输入验证

Inquirer.js提供了强大的输入验证功能，能够确保用户输入的数据符合预期。开发者可以自定义验证函数，根据具体需求进行验证。以下是输入验证的一些关键内容：

基本验证

基本验证用于检查用户输入是否为空。以下是基本验证的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
    validate: function (value) {
      if (value.length) {
        return true;
      } else {
        return 'Please enter your name.';
      }
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
});

正则验证

正则验证用于检查用户输入是否符合特定的正则表达式。以下是正则验证的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'email',
    message: 'What is your email?',
    validate: function (value) {
      const pass = value.match(/\S+@\S+\.\S+/);
      if (pass) {
        return true;
      } else {
        return 'Please enter a valid email address.';
      }
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Email:', answers.email);
});

自定义验证

自定义验证用于检查用户输入是否符合特定的业务逻辑。以下是自定义验证的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'age',
    message: 'What is your age?',
    validate: function (value) {
      const pass = value.match(/^\d+$/);
      if (pass) {
        const age = parseInt(value, 10);
        if (age >= 18) {
          return true;
        } else {
          return 'You must be at least 18 years old.';
        }
      } else {
        return 'Please enter a valid age.';
      }
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Age:', answers.age);
});

自定义提示符

Inquirer.js支持自定义提示符，能够根据具体需求调整提示符的外观和行为。开发者可以使用自定义的提示符来提升用户体验。以下是自定义提示符的一些关键内容：

基本自定义

基本自定义用于修改提示符的文本和颜色。以下是基本自定义的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
    prefix: '>',
    suffix: '?',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
});

动态提示符

动态提示符用于根据用户输入动态修改提示符的文本和颜色。以下是动态提示符的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: function (answers) {
      return `What is your name, ${answers.previousName || ''}?`;
    },
  },
  {
    type: 'input',
    name: 'previousName',
    message: 'What was your previous name?',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
  console.log('Previous Name:', answers.previousName);
});

自定义分隔符

自定义分隔符用于修改提示符的分隔符。以下是自定义分隔符的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
    separator: ' | ',
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
});

异步操作

Inquirer.js支持异步操作，能够处理复杂的异步逻辑。开发者可以使用异步函数来处理输入数据，确保命令行工具的高效性和可靠性。以下是异步操作的一些关键内容：

异步验证

异步验证用于检查用户输入是否符合特定的异步条件。以下是异步验证的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'input',
    name: 'username',
    message: 'What is your name?',
    validate: function (value) {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          if (value === 'admin') {
            resolve('This name is not allowed.');
          } else {
            resolve(true);
          }
        }, 1000);
      });
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Username:', answers.username);
});

异步选择列表

异步选择列表用于获取用户的单选输入，返回选中的值。以下是异步选择列表的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'list',
    name: 'color',
    message: 'What is your favorite color?',
    choices: function () {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          resolve(['Red', 'Green', 'Blue']);
        }, 1000);
      });
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Color:', answers.color);
});

异步复选框

异步复选框用于获取用户的多选输入，返回选中的值数组。以下是异步复选框的示例：

const inquirer = require('inquirer');

const questions = [
  {
    type: 'checkbox',
    name: 'colors',
    message: 'What are your favorite colors?',
    choices: function () {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          resolve(['Red', 'Green', 'Blue']);
        }, 1000);
      });
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Colors:', answers.colors);
});

插件扩展

Inquirer.js提供了丰富的插件生态系统，帮助开发者扩展和定制命令行工具的功能。开发者可以根据具体需求选择合适的插件，满足各种开发场景。以下是插件扩展的一些关键内容：

安装插件

Inquirer.js支持通过npm安装插件。以下是安装插件的示例：

  1. 安装插件：运行以下命令安装插件：

    npm install inquirer-autocomplete-prompt

  2. 导入插件：在Node.js文件中导入插件：

    const inquirer = require('inquirer');
const AutoCompletePrompt = require('inquirer-autocomplete-prompt');

inquirer.registerPrompt('autocomplete', AutoCompletePrompt);

  3. 使用插件：使用插件创建问题。以下是使用插件的示例：

    const inquirer = require('inquirer');
const AutoCompletePrompt = require('inquirer-autocomplete-prompt');

inquirer.registerPrompt('autocomplete', AutoCompletePrompt);

const questions = [
  {
    type: 'autocomplete',
    name: 'color',
    message: 'What is your favorite color?',
    source: function (answers, input) {
      input = input || '';
      return new Promise(function (resolve) {
        const colors = ['Red', 'Green', 'Blue', 'Yellow', 'Purple'];
        const filtered = colors.filter(color => color.toLowerCase().indexOf(input.toLowerCase()) !== -1);
        resolve(filtered);
      });
    },
  },
];

inquirer.prompt(questions).then(answers => {
  console.log('Color:', answers.color);
});

常用插件

Inquirer.js提供了多种常用的插件，帮助开发者扩展命令行工具的功能。以下是Inquirer.js的一些常用插件：

  • inquirer-autocomplete-prompt：提供自动补全功能。
  • inquirer-checkbox-plus-prompt：提供增强的复选框功能。
  • inquirer-fuzzy-path：提供模糊路径选择功能。
  • inquirer-search-list：提供搜索列表功能。
  • inquirer-table-prompt：提供表格选择功能。

总结

通过本文的详细介绍，我们深入了解了Inquirer.js这款强大的交互式命令行工具。从基础配置到高级功能，Inquirer.js展现了其在创建用户友好的命令行界面方面的卓越能力。其多种输入类型、强大的输入验证、自定义提示符和异步操作等功能，使得Inquirer.js成为许多开发者的首选工具。

在实际开发过程中，Inquirer.js的价值不仅体现在其提供的标准功能上，更在于其强大的可扩展性和适应性。无论是简单的命令行工具，还是复杂的交互式界面，Inquirer.js都能提供相应的解决方案。特别是在需要处理用户输入和创建复杂交互界面的场景下，Inquirer.js的优势更加明显。

SBoudrias
SBoudrias/Inquirer.js
一组常见的交互式命令行用户界面。
TypeScript
MIT
20.8 k