探索未使用的文件：next-unused

探索未使用的文件：next-unused

项目地址:https://gitcode.com/pacocoursey/next-unused

在你的Next.js项目中，是否曾经因为找不到哪些文件没有被引用而感到困扰？next-unused 就是为你解决这个问题的利器。这个开源工具能轻松定位并列出你的项目中未被使用的文件，帮助你保持代码库的整洁和高效。

安装与使用

要开始使用next-unused，首先将其作为devDependency安装：

$ yarn add next-unused -D

然后，在你的package.json中添加一个新的脚本来查找未使用的文件：

"scripts": {
  "find:unused": "next-unused"
}

运行以下命令，你就能看到所有未使用的文件了：

$ yarn find:unused

配置与自定义

项目配置可以通过package.json中的next-unused属性进行设置。你可以指定导入别名（alias），包括和排除的目录（include 和 exclude），以及入口点（entrypoints）。例如，如果你想要包含components目录，可以这样配置：

{
  "next-unused": {
    "include": ["components"]
  }
}

应用场景

无论你的Next.js应用规模大小，next-unused都是一个实用的维护工具。它特别适用于大型项目，或者团队协作时需要确保代码简洁无冗余的情况。通过定期检查并清理未使用的文件，你可以提升应用程序性能，并降低潜在的问题风险。

举例来说，假设你的项目结构如下：

package.json
├─ pages/
│  ├─ index.js
└─ components/
   ├─ button.js
   └─ image.js

在pages/index.js中只引用了button.js，那么next-unused会输出：

Found 1 unused file:
components/image.js

这样，你就可以清楚地知道哪个组件没有被使用，从而决定是否删除或优化。

项目特点

• 易用性：简单的一行命令即可完成扫描。
• 灵活性：自定义配置，包括导入别名、搜索范围和排除规则。
• 精准检测：准确识别未被引用的文件，避免误删有用代码。
• 集成友好：轻松整合到你的开发流程中，如CI/CD。

感谢最初的贡献者Shu和Luc，他们的努力使我们有了这样一个高效的小工具。

现在就尝试next-unused，让你的Next.js项目更加整洁高效吧！

项目地址:https://gitcode.com/pacocoursey/next-unused