npm 包 metalsmith-prompt 使用教程

面试官:小伙子,你的代码为什么这么丝滑?

为了帮助前端开发者更加便捷地生成静态网站,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


猜你喜欢

  • 如何在 Hapi 中使用 Socket.io 实现实时通信

    Socket.io 是一个基于 Node.js 的实时通信框架,可方便地实现服务端和客户端之间的实时通信。而 Hapi 是一个基于 Node.js 的 Web 开发框架,它提供了一些有用的工具和插件,...

    3 小时前
  • 在 ES9 中使用 obj.constructor() 函数创建对象

    在 JavaScript 中,我们通常使用对象字面量或构造函数来创建对象。但在 ES9 中,我们可以使用 obj.constructor() 函数来创建对象。这种方式可以让我们更加灵活地创建对象,并且...

    3 小时前
  • 如何使用 Mocha 测试 AngularJS 应用?

    Mocha 是一个流行的 JavaScript 测试框架,可针对多种应用程序和库进行测试。在前端开发领域中,测试是至关重要的一环,特别是对于 AngularJS 应用程序。

    4 小时前
  • Next.js 处理外部请求数据的方法和技巧

    Next.js 是一种流行的 React 框架,可以帮助我们构建可靠、可扩展的 Web 应用程序。与许多其他的 React 框架不同,Next.js 还提供了一些处理外部请求数据的方法和技巧,让应用程...

    4 小时前
  • 用 Fastify 实现自定义错误处理器

    Fastify 是一个基于 Node.js 的快速和低开销 Web 框架。它专为构建高效和可伸缩的服务而设计,提供了很多强大的功能,如内置的插件系统、路由、中间件等等。

    4 小时前
  • Kubernetes 中的 Job 和 CronJob 使用详解

    Kubernetes 是一个用于管理容器化应用程序的开源平台,它有助于在大规模分布式系统中轻松部署、管理和扩展应用。在 Kubernetes 中,Job 和 CronJob 是用于执行批处理任务和定期...

    4 小时前
  • 在 Hapi.js 中实现推送通知

    推送通知是现代 Web 应用程序的重要组成部分,使得您可以向用户传递实时信息,而无需用户每次主动获取。在这篇文章中,我们将探讨如何在 Hapi.js 中实现推送通知,以便更好地服务我们的用户。

    5 小时前
  • 用 Redis 响应快速的 GraphQL 查询

    GraphQL 是一种用于 API 的查询语言,可以让前端开发人员灵活地请求数据并减少不必要的网络请求。然而,在大型应用程序中,GraphQL 查询可以变得相当复杂和缓慢,尤其是在处理大量数据时。

    5 小时前
  • JavaScript 面向对象编程:ECMAScript 2021 中的类

    在 JavaScript 中,面向对象编程(OOP)是一种常见的编程范型。在 ECMAScript 2021 中,类被引入作为一种更加强大且方便的面向对象编程方式。

    5 小时前
  • Chai 报错:expected [] to have length 1 解决方法

    前言 在前端开发中,测试是非常重要的一部分。而 Chai 是一款常用的 JavaScript 测试库,它提供了许多有用的断言和 API,可以帮助我们进行测试驱动开发(TDD)和行为驱动开发(BDD)。

    5 小时前
  • Serverless 如何实现热启动?

    随着云计算技术的发展,Serverless 架构已经成为了一种越来越受欢迎的应用架构模式,它可以为开发者提供更快的部署、更低的成本和更好的可伸缩性。但是,Serverless 架构中的函数冷启动问题一...

    6 小时前
  • Redis 的应用场景与优缺点分析

    在前端开发中,缓存是一个非常有用的工具,它可以提高网站的响应速度以及数据传输的效率。而 Redis 作为一款常用的缓存服务器,可以应用在很多场景下。本文将介绍 Redis 的应用场景及其优缺点分析,旨...

    6 小时前
  • 如何在 React 中使用 WebSocket 进行实时通信

    WebSocket 是一种提供实时双向通信的协议,与传统的 HTTP 协议不同,它可以在客户端和服务器之间建立持久连接,使得服务器可以主动向客户端推送消息。React 作为一种流行的开发框架,为了实现...

    6 小时前
  • ECMAScript 2017 中的字符串填充方法:String.padStart() 和 String.padEnd()

    在 JavaScript 中,字符串操作一直是前端开发中最基础也最常用的功能之一,ECMAScript 2017 标准中新增的字符串填充方法 String.padStart() 和 String.pa...

    6 小时前
  • 以 Flex 布局构建响应式设计分割视图

    在当今网络应用程序生态系统中,设计响应式界面非常重要。这种技术允许用户适应不同设备和浏览器屏幕,并使应用程序对于各种设备尺寸都具有良好的适应性。因此,在开发前端应用程序时,设计响应式视图是必不可少的。

    6 小时前
  • 如何在 Angular 应用中实现单元测试

    如何在 Angular 应用中实现单元测试 单元测试在软件工程中是非常重要的一部分,它可以提高代码质量和可维护性。对于 Angular 应用来说,单元测试同样也是不可或缺的。

    6 小时前
  • 多方共建,让北京市无障碍发展健康前行

    多方共建,让北京市无障碍发展健康前行 随着互联网技术的迅猛发展,人们的交流和信息获取方式愈加多样化,但同时,我们也看到了无障碍互联网的重要性。 无障碍网站是指在设计、开发和使用时,考虑了所有人的需求,...

    7 小时前
  • Sequelize(ORM)基础

    在开发现代 Web 应用时,数据存储是不可或缺的一部分。一般而言,应用需要连接数据库来存储和检索信息。但是,直接连接数据库并进行数据操作通常是困难的,因为大部分关系数据库(如 SQLite,Postg...

    7 小时前
  • Deno 应用中如何处理 XML 格式数据

    引言 Deno 是一个新兴的 JavaScript 运行时环境,它与 Node.js 类似,但具有许多 Node.js 中缺失的特性,例如 TypeScript 的原生支持、安全的模块加载等等。

    7 小时前
  • React 中的内联样式和外部样式表的区别

    React 是一种广泛使用的 JavaScript 库,用于开发用户界面。React 支持一种特殊的语法,称为 JSX,它使得将 HTML 和 JavaScript 混合使用变得更加简单和直观。

    7 小时前