npm 包 prompt-answer 使用教程

阅读时长 8 分钟读完

前言

在前端开发中,我们常常需要与用户进行交互,获取用户的输入并根据其输入做出相应的动作。而在 Node.js 中,我们可以通过 npm 包 prompt-answer 来实现用户输入的获取和处理。

本文将详细地介绍 prompt-answer 的使用方法,包括如何安装和引入该包、如何创建一个基本的交互式命令行工具,并对每一个方法和参数进行详细讲解,希望通过本文的学习,读者能够灵活地使用 prompt-answer 完成自己的交互式命令行工具。

简介

prompt-answer 是一个 Node.js 包,用于从用户那里获取输入,并将用户的输入作为回调参数传递给您的代码。它基于 inquirer.js 构建,并添加了一些额外的特性,如自定义验证和错误捕获。

安装

在 Node.js 项目中安装和使用 prompt-answer 非常简单,只需在项目根路径下运行以下命令:

安装完成后,您可以在代码中引入 prompt-answer

使用方法

创建 prompt

创建一个 prompt 是 prompt-answer 的第一步。您可以采用链式语法,定义一组问题和选项,如下所示:

链中的所有 ask 方法都是 prompt-answer 的核心,每个 ask 方法会生成一个询问,询问会等待用户的输入,并将该输入存储在 answers 对象中。

在上面的示例中,当用户回答完最后一个问题后,answers 对象将包含所有问题的答案,您可以在 then 回调函数中读取它们并执行您需要的操作。

补充问题

除了使用 ask 方法询问问题之外,还可以使用 name 属性来添加额外的信息,例如默认值或类型。

-- -------------------- ---- -------
----- ------ - -
  ----------- -
    ----- -
      ----- -------
      -------- -----------
      -------- -- -- ----
    --
    ---- -
      ----- ------
      -------- -----------
      ---------- ------------------------ -- -------------- -----
      -------- ------ ------
    -
  -
-

------
  ------------
  ------------- -- -
    --------------------
  --

在上面的示例中,我们使用 name 属性在询问中添加了额外的信息,例如 defaultvalidator

分步骤提示

如果您想让用户逐步输入答案,则可以使用 prompt 的基本环节。

-- -------------------- ---- -------
----- ------ - -
 ----------- -
   ----- -
     ----- -------
     -------- ----------
   -
 -
-

-------- ------- -- -
 ------ ------------------
-

---------------------- -- -
 --------------------
--

在上面的示例中,我们使用了 getName() 函数,该函数将在 name 问题完成后返回一个 Promise,您可以等待 Promise 的完成并读取结果。

这种方法可将您的代码分为步骤,使其更易于阅读和管理。

深入理解

prompt-answer 可以接收下列类型的问题:

  1. 基本问题
  2. confirm 类型
  3. list 类型
  4. rawlist 类型

现在,我们将深入了解每种问题的使用方法和参数。

基本问题

基本问题是 prompt-answer 最简单的类型,它只询问您的一些信息,然后将您的答案存储在 answers 对象中以供您读取和使用。

下面是一个使用基本问题的例子:

-- -------------------- ---- -------
----- ------ - -
  ----------- -
    ----- -
      ----- -------
      -------- ----------
    -
  -
-

------
  ------------
  ------------- -- -
    --------------------
  --

在此示例中,我们使用 schema 对象的 properties 属性来定义问答的详情。在此例子中,我们只包含了一个基本问题,它要求我们输入我们的姓名。

如果您想要更多地了解基本问题,请查看 prompt-answer 官方文档。

confirm 类型

检查特定条件是否成立时,confirm 类型的问题是特别有用的,例如:

-- -------------------- ---- -------
----- ------ - -
  ----------- -
    --------- -
      ----- ----------
      -------- ---------------
      -------- ------
      ---------- ---------------
      -------- ---- --- - ----
      ----- ---------
    -
  -
-

------
  ------------
  ------------- -- -
    -- ----------------- -
      ----------------------
    - ---- -
      ----------------------
    -
  --

在此示例中,我们使用 confirm 类型的问题来询问何时删除文件。如果回答是“yes”或“y”,则文件将被删除。如果回答是“no”或“n”,则文件不会被删除。

在这种情况下,confirm 的回答是 truefalse

如果您想要更多地了解 confirm 类型,请查看 prompt-answer 官方文档。

list 类型

当您需要从一组特定的选项中选择时,请使用 list 类型的问题:

-- -------------------- ---- -------
----- ------ - -
  ----------- -
    ------------ -
      ----- --------
      -------- --------------
      ----- -------
      -------- -
        ------
        ---------
        -------
      -
    -
  -
-

------
  ------------
  ------------- -- -
    --------------------
  --

在此示例中,我们使用 list 类型的问题来列出我们可能感兴趣的几个选项。用户可以使用光标选择他们的选项,回车确认。list 的回答是选项数组中的一个元素。

如果您想要更多地了解列表类型,请查看 prompt-answer 的官方文档。

rawlist 类型

list 类型不同,rawlist 类型不包含描述、回答类型或预订标识。rawlist 类型仅显示选项清单以供用户选择:

-- -------------------- ---- -------
----- ------ - -
  ----------- -
    ------------ -
      ----- --------
      -------- --------------
      ----- ----------
      -------- -
        ------
        ---------
        -------
      -
    -
  -
-

------
  ------------
  ------------- -- -
    --------------------
  --

在此示例中,我们使用 rawlist 类型的问题来列出我们可能感兴趣的几个选项。用户可以使用光标选择他们的选项,回车确认。list 的回答是选项数组中的一个元素。

如果您想要更多地了解 rawlist 类型,请查看 prompt-answer 的官方文档。

参考代码

-- -------------------- ---- -------
----- ------ - ------------------------

----- ------ - -
  ----------- -
    ----- -
      ----- -------
      -------- ----------
    --
    ---- -
      ----- ------
      -------- -----------
      ---------- ------------------------
      -------- ------ ------
    -
  -
-

------
  ------------
  ------------- -- -
    --------------------
  --

总结

在本文中,我们详细介绍了 prompt-answer 的使用方法和参数,包括如何安装和引入该包、如何创建一个基本的交互式命令行工具,并对每一个方法和参数进行详细讲解。

希望本文可以帮助初学者更好地了解 prompt-answer 的功能和用法,并启发他们设计和实现自己的交互式命令行工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005595f81e8991b448d6c60

纠错
反馈