如果你是前端开发者，你会发现在建立一个项目时，需要用到大量的文件。但是，有时候我们无法发现哪些文件是不必要的或者没有使用的，而这些文件却占用存储空间。在这样的情况下，开发者们需要找到一种程序可以帮助他们查找和删除无用的或未使用的文件。在这里，我们将向您介绍一种 npm 包：unused-filename，它可以帮助您查找和删除无用的文件。
简介
unused-filename 是一个用于查找未使用的和不必要的文件的 npm 包。通过执行这个程序，您可以找到那些被遗弃的文件，然后进行清理。未使用的文件占用了磁盘空间，看起来并没有什么危害，但是在长时间的开发中，这些文件会变成一个巨大的问题。延迟任务的完成时间，会使项目的文件变得混乱，降低代码的规范性。
unused-filename 可以快速地找到那些无用的文件。这个程序将搜索项目中的所有文件和文件夹，查找与项目中所有文件和文件夹不相关的不必要的文件和文件夹。如果 File A 引用了 File B，那么 unused-filename 不会将 File B 作为未使用的文件。如果有任何文件未被引用，并且文件不符合以下规则，即标记为未使用：
- 文件名以__.打头的
- 在项目中除了代码以外，其他地方没有被引用过的
安装
使用以下 NPM 命令将 unused-filename 安装到您的项目中：
npm install unused-filename --save-dev
使用
安装 unused-filename 后，您可以使用以下命令在项目中查找无用的文件：
npx unused-filename
unused-filename 会在您的项目中查找未使用的文件并输出结果。它将告诉您哪些文件应该被删除，以及应该保留哪些文件。它会检查一下默认的忽略规则，忽略：`
- node_modules
- .git
- .svn
- .hg
- bower_components
- build
- coverage
- dist
- tmp
您可以使用跟随的参数定制忽略规则。
CLI参数
| 参数 | 描述 |
|---|---|
| --help | 显示帮助信息 |
| --version | 显示版本号 |
| -r, --root [path] | 指定项目的根目录 |
| -i, --ignore [pattern] | 指定要忽略的模式，多个模式用逗号隔开 |
| -e, --extensions [extension] | 指定要忽略的文件扩展名，多个扩展名用逗号隔开 |
| --no-color | 禁用输出的颜色 |
示例
假设您的项目文件组织结构如下：
-- -------------------- ---- -------
- ----------
- ---
- --------
- --------
- ------
- --------
- ------
- ---------
- ----
- --------假设您想要查找未使用的文件。您可以在项目根目录中运行以下命令：
npx unused-filename
输出结果如下：
Unused Files: - app/main.css - app/vendor/jquery.js - app/images/logo.png OK Files (kept): - app/index.js - test/index.js
unused-filename 告诉我们，my-project/app/main.css、my-project/app/vendor/jquery.js 和 my-project/app/images/logo.png 都是未使用的文件。在此示例中，我们应该删除这些文件。
常规用例
unused-filename 是一个优秀的命令行工具，如果你在项目中使用它，它将帮助你找到那些未使用的文件。为了更好的保持项目干净，团队中可以定期执行这个程序。它是非常有用的工具，因为它可以帮助开发人员找到所有未使用的文件，这样他们就可以删除它们，以减少项目的大小和增加代码的质量和效率。
如果你想学习更多关于 npm 包 unused-filename 的例子，你可以访问官方文档：npmjs.com/package/unused-filename
总结
在这篇文章中，我们向您介绍了 unused-filename 这个 npm 包。通过使用这个 npm 包，开发者可以快速找到以前遗留下来并不需要的文件，这样可以保持代码库干净和规范。我们希望这篇教程对您开发前端项目是有帮助的。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/69278