在前端开发过程中，随着项目越来越复杂，需要管理的文件也越来越多。如果手动维护一个文件列表会非常繁琐和容易出错。这时候，我们可以使用一个非常有用的 npm 包：directoryfiles。directoryfiles 可以帮助我们自动生成文件列表，并将其保存到一个 JSON 文件中，极大地方便了我们的工作。
安装
在使用 directoryfiles 之前，需要先安装它们。打开终端，进入项目根目录，运行以下命令：
npm install directoryfiles --save-dev
使用
安装完成后，在项目的任何一个 JavaScript 文件中，可以使用下面的代码来生成文件列表：
const directoryFiles = require('directoryfiles');
directoryFiles({
directory: './src',
outputFile: './src/fileList.json',
ignore: ['node_modules', 'dist', '.git'],
prefix: ''
});directoryfiles 接受一个配置对象作为参数，其中必须要设置 directory 和 outputFile。directory 是要搜索的目录，outputFile 是生成的文件列表 JSON 文件的保存路径。如果需要忽略某些目录，可以传入一个 ignore 数组。最后，可以使用 prefix 参数来给文件名添加前缀，方便处理一些特殊场景。
运行上面的代码，将会在 src 目录下生成一个名为 fileList.json 的文件。文件内容类似下面的格式：
{
"test.js": "./src/test.js",
"utils/file1.js": "./src/utils/file1.js",
"utils/file2.js": "./src/utils/file2.js",
}文件名作为 key，文件路径作为 value。这样的数据结构非常便于我们在代码中动态引用和操作文件。
示例
下面是一个使用 directoryfiles 自动生成文件列表的示例代码，假设我们有一个 controllers 目录下面包含了多个控制器文件。我们可以通过自动生成文件列表，动态地加载这些控制器，并注册到路由中。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- -------------- - -------------------------- ----- --- - ---------- ----- ---- - ----- ---------------- ---------- ---------------- ----------- ------------------------------ ------- --- ------- -------------- --- ------------ ----- ---- -- - --------------- -------- --- ----- -------- - --------------------------------------- ------- ---- -- --------- - ----- ---- - ------------------------------ ------------------------------ ------ ------ - ---------------- -- -- - -------------------- --- --------- -- -------------------------- ---
运行该代码后，会自动加载所有控制器，并将它们的路由注册到 Express 应用程序中。如果有新的控制器加入，也不需要手动更改代码，只需要重新生成一次文件列表即可。这大大提高了开发效率和代码的可维护性。
总结
directoryfiles 是一个非常实用的 npm 包，可以帮助我们自动生成文件列表，极大地方便了代码的编写和维护。在日常开发中，我们可以根据具体业务场景使用 directoryfiles，从而提高自己的开发效率和代码的可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005672381e8991b448e398f