前言
在前端开发中，常常需要处理文件系统相关的任务，例如读取、遍历文件夹，判断文件类型等等。而 Node.js 作为一种基于事件驱动、非阻塞 I/O 的平台，提供了一系列操作文件系统的 API，其中包括 fs.readdir、fs.stat、fs.writeFile 等等。
然而，由于 Node.js API 的设计限制，开发者需要编写大量的代码才能完成一个简单的文件系统任务。此时，我们就需要借助其他的库来提高开发效率，而 @nodelib/fs.walk 正是其中一款非常优秀的库。
@nodelib/fs.walk 是一个 Node.js 的文件夹遍历库，非常轻量级且易于使用，可以帮助我们在 Node.js 应用中快速高效地遍历文件夹。下面，让我们来一起学习一下 @nodelib/fs.walk 的使用。
安装
首先，我们需要在 Node.js 应用中安装 @nodelib/fs.walk。使用 npm 即可完成安装：
npm install @nodelib/fs.walk
基本使用
下面，让我们以一个简单的例子来说明 @nodelib/fs.walk 的基本使用：
-- -------------------- ---- -------
----- ---- - ----------------------------
----- ------- - -
-------------------- ------
-------- -
--------------
-
--
--------------- -------- ------- -------- -- -
-- ------- -
---------------------
- ---- -
---------------------
-
---首先，我们加载了 @nodelib/fs.walk ，接着定义了配置项 options。其中 followSymbolicLinks 控制是否跟随符号链接，filters 控制需要过滤的目录。在这个例子中，我们将会跳过 node_modules 目录。
最后，我们调用 walk 方法，传入需要遍历的目录，配置项以及一个回调函数。回调函数的第一个参数是可能的错误，第二个参数为遍历得到的结果。在这个例子中，我们仅仅只是将结果打印出来了。
深入指南
除了基本使用外，@nodelib/fs.walk 还支持更高级的使用，例如自定义过滤器、扩展处理器等等。下面，我们将会详细介绍这些用法。
过滤器
filters 参数用于过滤需要跳过的目录或者文件，参数类型为数组，可以包含正则表达式或者字符串。例如：
const options = {
filters: [
/node_modules/,
'.git'
]
};在这个例子中，我们跳过了 node_modules 和 .git 目录。需要注意的是，filters 数组中的正则表达式是从左到右依次应用的，匹配成功即跳过。因此，如果我们需要跳过多个目录，应该注意正则表达式的顺序。
扩展处理器
有时候，我们需要自定义如何处理
@nodelib/fswalk 遍历得到的结果。@nodelib/fswalk 提供了 transform 参数用于自定义处理方法。
-- -------------------- ---- -------
----- ------- - -
---------- ------- --------- -- -
-- --------------------- -
-- ---
- ---- -- ---------------- -
-- ---
- ---- -- ------------------------ -
-- ---
- ---- -
-- ---
-
-----------
-
--在这个例子中，我们自定义了 transform 方法，根据遍历得到的结果来处理文件或者目录。需要注意的是，transform 回调方法的最后一个参数必须是 callback，否则会导致遍历一直阻塞。
同步 API
@nodelib/fs.walk 还提供了同步的遍历方法：
const walkSync = require('@nodelib/fs.walk').walkSync;
const entries = walkSync('./');
console.log(entries);在这个例子中，我们使用了 walkSync 方法同步遍历文件。需要注意的是，这种方式可能导致 Node.js 应用使用过多的内存和处理器资源，因此不建议使用。
总结
总的来说，@nodelib/fs.walk 是一个非常优秀的 Node.js 文件系统遍历库，通过学习本文，相信读者都已经了解了 @nodelib/fs.walk 的基本使用和高级用法。在实际开发中，我们应该根据具体的业务需求来选择使用相应的库。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc3ebb5cbfe1ea061216a