ts-prune: TypeScript 项目中查找未使用的导出教程

ts-prune: TypeScript 项目中查找未使用的导出教程

ts-prune Find unused exports in a typescript project. 🛀 项目地址: https://gitcode.com/gh_mirrors/ts/ts-prune

---

项目介绍

ts-prune 是一个用于检测 TypeScript 项目中未被使用的导出的工具。在TypeScript生态系统中，随着项目规模的增长，保持代码库的整洁成为一项挑战。此工具通过分析tsconfig.json配置文件来识别那些没有被其他代码部分引用的导出定义，从而帮助开发者进行代码清理，提高代码质量。

维护状态: 注意，ts-prune已进入维护模式，并推荐使用knip作为其精神继承者，因为随着功能需求增加带来的复杂度膨胀，开发者不再增加新特性或核心系统变更，专注于关键bug修复和第三方代码漏洞修补。

项目快速启动

安装

要开始使用 ts-prune，首先确保你的环境已经安装了 Node.js。然后，可以通过以下命令添加到你的项目中：

使用npm

npm install ts-prune --save-dev

或者使用yarn

yarn add -D ts-prune

使用

安装完成后，你可以通过创建或者修改你的package.json中的脚本来轻松调用它，例如：

{
  "scripts": {
    "find-unused": "ts-prune"
  }
}

之后，只需执行 npm run find-unused 或 yarn run find-unused，即可查看哪些导出可能是未被使用的。

如果需要指定不同的tsconfig.json文件或者忽略特定路径，可以使用命令行参数，例如：

ts-prune -p tsconfig.dev.json -i 'test/**/*.ts'

应用案例和最佳实践

当你进行版本更新前，或者为了提升代码健康度时，运行 ts-prune 来找出并移除未使用的导出可以帮助减少项目的整体大小和潜在的编译错误。最佳实践中，结合持续集成（CI）流程，自动化运行 ts-prune 可以保证代码库的持续干净和高效。

示例场景

• 清理旧代码: 在重构或迁移到新架构之前。
• 日常编码习惯: 定期执行，养成良好代码管理习惯。
• 团队协作: 确保合并到主分支前代码质量，避免引入无效导出。

典型生态项目关联

虽然ts-prune本身是个独立工具，但在现代前端开发流程中，它可以很好地与各种构建工具和持续集成服务（如Jenkins、GitLab CI/CD、GitHub Actions等）相结合，实现自动化的代码检查流程。此外，与代码质量和格式化工具（如ESLint、Prettier）一起使用，能够全面提升代码标准和可维护性。

由于ts-prune进入维护模式，考虑长期发展，探索与支持更多TS生态特性的新工具（比如上述提到的knip或其他未来可能的替代品）结合使用，也是保持项目现代化的重要策略。

---

通过以上步骤和实践，你可以有效地利用ts-prune来优化你的TypeScript项目，确保代码库的健壮性和清晰度。记住，定期的代码审查和清理是软件工程的健康实践之一。

ts-prune Find unused exports in a typescript project. 🛀 项目地址: https://gitcode.com/gh_mirrors/ts/ts-prune