npm 包 Ferment 使用教程

阅读时长 4 分钟读完

Ferment 是一个非常实用的 JavaScript 库,可以帮助前端开发人员简化代码和提高生产效率。它可以用于工作流自动化、生成静态文件、编译样式等多种场合。下面将详细介绍 Ferment 的使用方法,希望能帮助初学者更好地掌握这个工具。

安装 Ferment

在使用 Ferment 之前,需要先安装它。可以使用 npm 安装,命令如下:

这会在全局环境中安装 Ferment,使它可以被任何项目访问。

Ferment 的使用

构建文件

在使用 Ferment 之前,需要先定义一个 Fermentfile.js 文件。这个文件描述了要使用 Ferment 完成的任务和流程。

下面是一个简单的 Fermentfile.js 文件的例子:

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

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

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

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

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

这个 Fermentfile.js 文件定义了 3 个任务:copy-htmlcssjs。这 3 个任务都会将源文件处理后输出到 dist 目录。build 任务将这 3 个任务并行执行。在这个例子中,首先使用 sass() 编译样式文件,然后使用 babel() 编译 JS 文件,最后使用 uglify() 压缩 JS 文件。

运行 Ferment

定义好 Fermentfile.js 文件后,就可以通过命令行运行 Ferment 了。运行 Ferment 程序时,需要传递 Fermentfile.js 文件路径,命令如下:

如果 Fermentfile.js 文件在当前目录下,可以省略 --file 参数:

然后 Ferment 将执行定义在 Fermentfile.js 中的任务。

Ferment API

Ferment 提供了一系列 API 用于编写任务,包括 tasksrcdestseriesparallel

task(name, fn)

定义一个任务。

src(patterns)

返回一个可读流,用于读取匹配指定模式的文件。

dest(folder)

返回一个可写流,用于将经过处理后的文件写入指定目录。

series(tasks)

按顺序依次执行指定的任务,每个任务都必须完成才能执行下一个任务。

parallel(tasks)

并行执行指定的任务,所有任务都执行完毕后才算完成。

Ferment 示例

下面是一个简单的 Ferment 示例,该示例将处理 src 文件中的全部 JS 文件,将其合并成一个压缩文件,并输出到 dist 目录。

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

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

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

在控制台中输入 ferment 命令即可执行以上脚本,实现 JS 文件的合并压缩。

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