简介
ape-asking 是一个基于 Node.js 的命令行工具，它可以让你创建一个问答式的 CLI。使用者可以通过按照提示回答问题来完成一些操作，例如初始化一个项目的配置文件。这种方式的优点是可以让用户在不需要关心具体的命令和参数的情况下完成操作，也可以规范化用户的回答，提高了系统的健壮性和用户体验。
安装
ape-asking 是一个 npm 包，安装非常方便。首先需要确保你已经安装了 Node.js，然后在命令行中执行以下命令即可安装：
npm install ape-asking --save
使用
首先，我们需要在代码中引入 ape-asking：
const ApeAsking = require('ape-asking');然后，我们需要创建一个 ApeAsking 的实例：
const asking = new ApeAsking({
name: 'my-cli',
description: 'This is a CLI tool for my project.',
author: 'Jayden <jayden@example.com>',
})实例化 ApeAsking 的时候，可以传入一些配置参数。这些参数可以在用户使用命令时展示出来，提供更好的信息。
创建好 asking 实例之后，我们需要定义一些问题和答案。问题和答案需要作为数组传入：
-- -------------------- ---- -------
----- --------- - -
-
----- ---------------
-------- ------- ----- ---- ------- -------
-------- -------------
--
-
----- --------------
-------- ------- ----- --- ------ -------
-------- ----------------------
--
-
----- ----------
-------- --- --- ---- -- --- ---- -------
-------- ----
--
--
------------------------------------ -- -
----------------- ------- ---- ---- ----------------------
---------------- ------ ---- ---- ---------------------
-- ---------------- --- ---- -
---------------- ------ -- --- -------
- ---- -
---------------- ------ --- -- --- -------
-
---这段代码中定义了三个问题，分别是输入项目名、输入作者名和选择是否使用 npm。用户回答问题之后，我们可以通过 then() 方法获取到用户的回答。最后在 then() 方法中输出用户的回答即可。
API
ApeAsking(options)
创建一个 ApeAsking 实例。
参数
- options (Object): 配置
配置对象可以包含以下属性：
- name (string): CLI 的名字
- description (string): CLI 的描述
- author (string): 作者信息
asking.ask(questions)
发起一个问题列表。
参数
- questions (Array): 问题列表
问题列表应该是一个包含多个对象的数组，每个对象包含以下属性：
- name (string): 问题的名称，用于标识回答
- message (string): 问题的内容
- default (string): 问题的默认回答值
返回值
- Promise<answers>
这个 Promise 会在用户回答完所有问题后 resolve，resolve 的结果是一个对象，包含每个问题的回答值。
示例代码
在一个命令行工具中使用 ape-asking 创建项目：
-- -------------------- ---- -------
----- --------- - ----------------------
----- ------ - --- -----------
----- ---------
------------ ----- -- - --- ---- --- -- ----------
------- ------- ----------------------
---
----- --------- - -
-
----- ---------------
-------- ------- ----- ---- ------- -------
-------- -------------
--
-
----- --------------
-------- ------- ----- --- ------ -------
-------- ----------------------
--
-
----- ----------
-------- --- --- ---- -- --- ---- -------
-------- ----
--
--
------------------------------------ -- -
----------------- ------- ---- ---- ----------------------
---------------- ------ ---- ---- ---------------------
-- ---------------- --- ---- -
---------------- ------ -- --- -------
- ---- -
---------------- ------ --- -- --- -------
-
---在命令行中执行这段代码，就可以按照提示回答问题创建一个项目的配置信息了。
结语
ape-asking 是一个不错的 npm 包，可以让我们很方便地创建问答式的 CLI 工具。它的 API 简单易用，但是也提供了一些配置项和事件，可以让我们灵活地定制我们的 CLI 工具。希望这篇文章对你有帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/68023