ts-prune实战：5个真实场景教你高效清理项目代码

ts-prune实战：5个真实场景教你高效清理项目代码

【免费下载链接】ts-pruneFind unused exports in a typescript project. 🛀项目地址: https://gitcode.com/gh_mirrors/ts/ts-prune

ts-prune是一款简单高效的工具，能够帮助你在TypeScript项目中找出未使用的导出代码，实现零配置快速清理项目冗余。通过使用ts-prune，你可以轻松删除无用的导出，减小项目体积，提升代码质量，让代码库保持精简和可维护性。

场景一：基础扫描与结果解读

快速安装与运行

首先，通过npm、yarn或pnpm将ts-prune安装为开发依赖：

# npm npm install --save-dev ts-prune # yarn yarn add --dev ts-prune # pnpm pnpm add --save-dev ts-prune

在项目根目录运行基本命令：

npx ts-prune

理解输出结果

运行后，你会看到类似以下的输出：

src/components/Button.ts:15 - ButtonVariant src/utils/helpers.ts:8 - formatCurrency src/types/user.ts:12 - UserRole src/api/client.ts:45 - ApiResponse

每一行结果的格式为：文件路径:行号 - 导出名称，清晰地指出了哪些导出未被使用。

场景二：忽略特定导出

在实际项目中，有些导出可能暂时未被使用但计划在未来使用，或者在特定场景下才会被使用。这时可以使用// ts-prune-ignore-next注释来忽略特定导出：

// src/api/types.ts export interface User { id: string; name: string; } // ts-prune-ignore-next export interface AdminUser extends User { // 被ts-prune忽略 permissions: string[]; } export interface Customer { // 未使用时会被标记 customerId: string; }

这种方式可以灵活地排除那些暂时不需要清理的导出，避免误删有用代码。

场景三：处理不同类型的导出

ts-prune能够识别多种TypeScript导出模式，包括默认导出、命名导出和重导出等：

// 默认导出 export default class MyClass {} // 命名导出 export const myFunction = () => {}; export type MyType = string; export interface MyInterface {} // 重导出 export { SomethingElse } from './other-file'; export * from './barrel-file';

无论是哪种导出类型，只要未被使用，ts-prune都能准确识别并报告。

场景四：集成到CI/CD流程

为了在项目开发过程中持续保持代码清洁，可以将ts-prune集成到CI/CD流程中。在package.json中添加脚本：

{ "scripts": { "deadcode": "ts-prune", "deadcode:ci": "ts-prune --error" } }

使用--error选项，当检测到未使用的导出时，ts-prune会以非零错误码退出，从而中断CI流程，提醒开发者在合并代码前清理无用导出。

场景五：高级过滤与统计

统计未使用导出数量

通过管道命令可以统计未使用导出的总数：

ts-prune | wc -l

过滤特定结果

结合grep命令可以过滤出特定目录或排除某些文件的结果：

# 忽略测试文件 ts-prune | grep -v "\.test\." # 只显示组件目录的结果 ts-prune | grep "src/components" # 忽略多个模式 ts-prune | grep -v -E "(test|spec|stories)"

这些命令可以帮助你更精准地定位需要清理的代码。

注意事项与局限性

虽然ts-prune功能强大，但也有一些局限性需要注意：

• 动态导入：import('./dynamic-file')这类动态导入的使用情况可能无法被检测到
• 字符串导入：require('module-name')等字符串形式的导入也可能无法识别
• 框架特性：某些框架通过反射机制使用导出的情况可能会被误判为未使用
• 配置文件：配置文件中的导出可能显示为未使用

对于这些情况，可以使用// ts-prune-ignore-next注释或配置忽略模式来避免误报。

总结

ts-prune是TypeScript项目清理未使用导出的得力工具，通过本文介绍的5个真实场景，你可以快速掌握其使用方法，有效提升项目代码质量。无论是基础扫描、忽略特定导出，还是集成到CI/CD流程，ts-prune都能帮助你轻松实现代码清理，让项目保持精简高效。

如果你是JavaScript项目，只需在tsconfig.json中设置"allowJs": true，ts-prune同样可以发挥作用。开始使用ts-prune，让你的项目远离冗余代码吧！

【免费下载链接】ts-pruneFind unused exports in a typescript project. 🛀项目地址: https://gitcode.com/gh_mirrors/ts/ts-prune