在前端开发中，常常需要读取文件目录以及文件内容，特别是在某些自动化构建工具中需要单独对某些目录或文件进行操作。在这种情况下，一个好用的 npm 包可以极大的提高我们的工作效率。read-dir-recur 就是一个非常好用的 npm 包，它可以帮助我们轻松读取整个文件夹的目录和文件内容，并且使用起来也非常简单。
安装 read-dir-recur
使用 npm 包管理器，从 npm 注册表中安装 read-dir-recur：
npm install read-dir-recur
使用 read-dir-recur
在安装了 read-dir-recur 后，我们便可以通过 require 引入这个模块：
const readDirRecur = require('read-dir-recur');接下来，我们就可以使用这个模块读取整个文件夹的目录结构和文件内容了：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------------ - -------------------------- ----- ------- - -------------------- -------------- --------------------- ---------- ----- -------- -- - ---------------------- -- ------ ------------------ -- -------- --------------------- -- ------ ---
以上代码根据路径读取指定的文件夹（在这个例子中是 test-dir），然后打印每个文件的路径、状态信息和文件内容。如果读取成功，输出将类似于以下内容：
-- -------------------- ---- ------- ------------------------------------------ - ---- ---- ----- ------ ------ -- ---- ---- ---- --- ----- -- -------- ----- ---- -------- ----- ---- ------- -- -------- ------------------- -------- ------------------- -------- ------------------- ------------ ------------------- ------ ------------------------- ------ ------------------------- ------ ------------------------- ---------- ------------------------ - ---- -- ---- - ------- -------------------------------------------------- - ---- ---- ----- ------ ------ -- ---- ---- ---- --- ----- -- -------- ----- ---- -------- ----- ---- ------- -- -------- ------------------- -------- ------------------- -------- ------------------- ------------ ------------------- ------ ------------------------- ------ ------------------------- ------ ------------------------- ---------- ------------------------ - ---- -- ---- - -------
read-dir-recur 参数详解
read-dir-recur 支持 2 个参数：路径和回调函数。其中，路径为必填参数，回调函数则是实现具体功能的主要部分。
readDirRecur(path, callback, options)
路径
指定需要读取目录的路径，路径需使用完整的绝对路径。可以通过 node.js 内置模块 path 的 join 方法来构成完整路径。
回调函数
在回调函数中实现对于读取到的每个文件的处理逻辑。回调函数需要传入三个参数：
- filePath 文件路径
- stat 文件状态，包含文件属性的描述对象（例如 inode、权限、时间戳等）
- content 文件内容，只有当 readDirRecur 的第三个 options 参数为 'utf-8' 时才会包含文件内容
readDirRecur('/path/to/dir', (filePath, stat, content) => {
// filePath 是文件完整路径
// stat 是一个描述文件属性的对象
// content 是包含该文件内容的字符串
// 在这里实现文件处理逻辑
});options
options 参数是可选的，一般用于指定读取的文件编码格式。options 是一个对象，包含一个属性 encoding，表示读取文件的编码格式，默认为 null，表示读取二进制文件。
const options = {
encoding: 'utf8',
};
readDirRecur('/path/to/dir', (filePath, stat, content) => {
console.log(content); // 输出 utf-8 编码的文件内容
}, options);示例代码
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------------ - -------------------------- ----- ------- - -------------------- -------------- --------------------- ---------- ----- -------- -- - ------------------ -------------- ------------------ -------------------------- ------------------ --------------- ---
以上代码读取了 test-dir 文件夹下的所有文件的路径、状态和内容，并将结果打印到控制台中。
总结
在前端开发中，使用 read-dir-recur 可以轻松地读取整个文件夹的目录和文件内容，并且使用也非常简单。如果你经常需要读取文件内容或者文件目录，建议你试试这个 npm 包，相信它会给你带来意想不到的便捷。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066b5a51ab1864dac66f8e