在前端开发中，常常需要获取某个目录下的所有文件，然后对这些文件进行处理。而手动获取这些文件非常麻烦，而且还容易出错。此时，一个名为 get-all-files 的 npm 包就能为我们解决这个问题。
简介
get-all-files 是一个小巧的 npm 包，用于获取指定目录（包括子目录）下的所有文件名和文件路径。该包支持异步和同步两种方式。在使用 get-all-files 之前，你需要安装 Node.js 环境，以及 npm 包管理器。
安装
你可以使用 npm 包管理器安装 get-all-files。在命令行中输入以下命令即可：
npm install get-all-files
使用方法
同步方式
在使用 get-all-files 的同步方式时，你需要使用 require 将该包引入，并在代码中传入目录路径即可。示例代码如下：
const getAllFilesSync = require('get-all-files').sync; const path = './someDir'; // 目录路径 const results = getAllFilesSync(path); // 获取所有文件名和文件路径 console.log(results); // 输出结果
异步方式
在使用 get-all-files 的异步方式时，你需要使用 require 将该包引入，并使用 Promise 将结果进行包装。同样需要传入目录路径作为参数。示例代码如下：
-- -------------------- ---- ------- ----- ----------- - ------------------------------- ----- ---- - ------------ -- ---- ----------------- --------------- -- - --------------------- -- ---- -- ------------ -- - ------------------- ---展开代码
返回结果
无论是同步方式还是异步方式，get-all-files 返回的都是一个数组，包含目录下所有文件的相对路径和绝对路径（Windows 系统下为反斜杠分隔符）。
例如，以下是某个目录下的文件结构：
-- -------------------- ---- ------- --- ------- - --- ---- - - --- -------- - - --- -------- - --- ---- - - --- -------- - - --- -------- - --- ---------- - --- ---------展开代码
当你传入该目录路径时，get-all-files 将返回以下数组：
[ { relativePath: 'dir1/file1.js', absolutePath: '/path/to/someDir/dir1/file1.js' }, { relativePath: 'dir1/file2.js', absolutePath: '/path/to/someDir/dir1/file2.js' }, { relativePath: 'dir2/file3.js', absolutePath: '/path/to/someDir/dir2/file3.js' }, { relativePath: 'dir2/file4.js', absolutePath: '/path/to/someDir/dir2/file4.js' }, { relativePath: 'file5.html', absolutePath: '/path/to/someDir/file5.html' }, { relativePath: 'file6.css', absolutePath: '/path/to/someDir/file6.css' } ]
学习和指导意义
get-all-files 将返回目录下所有文件的相对路径和绝对路径，这对于 Web 开发中的文件处理非常有用。例如，在 Webpack 中使用该包，你可以轻松获取某个目录下所有的入口文件，从而更加方便地进行打包。另外，该包的核心代码也很简单明了，这让初学者可以更好地学习和理解 JavaScript 和 Node.js 的相关知识。
结语
get-all-files 是一个非常好用的 npm 包，它可以方便地获取指定目录下的所有文件，是 Web 开发中必备的工具之一。在使用时，你需要根据自己的需求选择异步或同步方式，并适当处理返回结果。学习和掌握该包的使用，能够让你更加熟练地处理文件和路径，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5efb1c5e403f2923b035ba9d
