npm 包 metalsmith-prompt 使用教程

阅读时长 5 分钟读完

为了帮助前端开发者更加便捷地生成静态网站,Metalsmith 是一个非常流行的构建工具。而 metalsmith-prompt 这个小型的 npm 包,可以使 metalsmith 更加交互式。本文将详细介绍 metalsmith-prompt 的使用方法及指导意义。

安装 metalsmith-prompt

在项目目录下,输入以下命令即可安装 metalsmith-prompt:

metalsmith-prompt 的功能

metalsmith-prompt 可以为 metalsmith 增加交互功能,比如输入、选择等。具体而言,metalsmith-prompt 可以:

  • 提供用户输入,如文本、数字等;
  • 提供用户选择,如单选、多选等;
  • 支持嵌套,形成交互式的问答流程;
  • 支持必需值和默认值;
  • 十分灵活,可以根据需求自由组合。

metalsmith-prompt 的使用方法

使用 metalsmith-prompt 时,需要与 metalsmith 配合使用。首先执行 metalsmith,然后通过 prompt 插件添加交互式功能。

必要插件

在使用 metalsmith-prompt 之前,需要安装以下插件:

添加 prompt 插件

在安装好必要插件后,需要在执行 metalsmith 的基础上,添加 prompt 插件。具体而言,需要在 metalsmith 内部添加 prompt 插件,然后执行 metalsmith:

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

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

在上面的代码中,首先使用 metalsmith().use() 的形式添加 collections 和 markdown 插件。然后添加 prompt 插件,其中包含三个参数:

  • type:交互方式,可以是 input、confirm、select、multiselect 等;
  • message:提示语;
  • required:是否必须;
  • default:默认值;
  • choices:可选项。

效果演示

在执行上述代码时,metalsmith 会在命令行上提示用户输入相应的值,如下图所示:

最终,输入的交互值会被合并到 metadata 内部。在上述代码中,可以使用下列方式从 metadata 中获取相应的值:

指导意义

通过上述的演示代码,可以看到 metalsmith-prompt 的用法。metalsmith-prompt 将 metalsmith 的静态网站构建工具转化为交互式的版本,更加人性化、方便。使用 metalsmith-prompt,开发者可以:

  1. 更加直观地调试代码,比较容易发现问题;
  2. 更加高效地构建静态网站,省去了手动编辑代码的过程;
  3. 有助于开发者进一步了解并应用 metalsmith 的插件及其配置,进而提高开发效率。

示例代码

完整的示例代码可到我的 GitHub 仓库 下载。

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