探索智能命令行补全：inquirer-autocomplete-standalone

在CLI中实现智能命令行补全从未如此简单！

inquirer-autocomplete-standalone 是一个基于 inquirer 的独立命令行自动补全提示插件。它能根据用户的输入动态显示列表选择项，无论是同步还是异步，甚至可以连接到外部服务获取实时数据。

安装

要安装这个强大的工具，只需一条简单的命令：

npm install inquirer-autocomplete-standalone

对于CommonJS环境，请按照以下方式导入：

const { default: autocomplete, Separator } = await import('inquirer-autocomplete-standalone');

如果你还在使用旧版的inquirer（版本9以下），则可以找到 inquirer-autocomplete-prompt ，但官方推荐升级到新版本以获得更好的体验和性能。

快速体验

想要立即试一试？运行下面的命令，开启你的智能补全之旅：

npx inquirer-autocomplete-demo

使用示例

让我们通过一个例子来了解如何使用这个库：

import autocomplete from 'inquirer-autocomplete-standalone';
import { searchCountries } from './some-external-api'; // 假设这是一个返回国家列表的API

const answer = await autocomplete({
  message: 'Travel from what country?',
  source: async (input) => {
    const filteredCountries = await searchCountries(input);
    return filteredCountries.map((country) => ({
      value: country,
      description: `${country} is a great place to visit`,
    }));
  },
});

// 用户搜索并从列表中选择一个国家
console.log(answer); // 输出：Norway

这将展示一个交互式界面，用户输入时会实时过滤并显示匹配的国家。

功能特性

• 支持异步和同步的数据源函数，可以根据用户输入动态更新选项。
• 提供自定义的值转换器（transformer）进行视觉格式化，但不影响实际答案。
• 自定义验证功能，确保用户输入的有效性。
• 显示分隔符，方便组织选项列表。
• 选项列表支持页面滚动，方便浏览长列表。
• 提供默认值设置。

选项详解

以下是你可以配置的一些主要选项及其说明：

• message：提问的文本。
• source：根据用户输入提供选项的函数。
• transformer：用于格式化用户输入的字符串。
• validate：提交答案时进行验证的函数。
• default：默认选定的值或选择项。
• emptyText：当没有搜索结果时显示的文本。
• pageSize：控制单页显示的选择项数量。
• searchText：等待搜索结果时显示的文本。
• suggestOnly：是否允许直接使用输入内容作为答案，而不必从列表中选择。

选择项类型与描述

每个选项都可以包含 value、name、description 和 disabled 属性，其中：

• value 是最终的回答值。
• name 用于显示。
• description 可选地提供额外信息。
• disabled 可禁用选项。

此外，还可以添加 Separator 来分组选项，增强可读性。

致谢与许可

感谢 Martin Hansen 创建了这个出色项目，并采用 ISC 许可证发布。

结论

inquirer-autocomplete-standalone 是构建强大命令行应用的理想选择，无论你是想为内部工具增添智能提示，还是希望提升用户在CLI中的交互体验。现在就开始集成它，让命令行操作变得更加高效和便捷。