knip-deadcode

社区 Knip 死代码检测最佳实践

使用 Knip 检测并移除 JavaScript 和 TypeScript 项目中死代码的综合指南。包含 8 个类别中的 43 条规则，并按影响排序，以指导配置、CI 集成和清理工作流。

适用场景

在以下情况下参考这些指南：

• 为新项目或 monorepo 配置 Knip
• 调查误报或漏报
• 设置 CI 流水线，防止死代码回归
• 使用自动修复清理未使用的代码
• 优化 Knip 在大型代码库中的性能

按优先级划分的规则类别

优先级	类别	影响	前缀
1	配置基础	严重	config-
2	入口点策略	严重	entry-
3	Workspace 与 Monorepo	高	workspace-
4	依赖分析	高	deps-
5	导出检测	中高	exports-
6	CI 集成	中	ci-
7	自动修复工作流	中	fix-
8	性能优化	低中	perf-

快速参考

1. 配置基础（严重）

• config-avoid-broad-ignore - 避免使用宽泛的忽略模式
• config-configure-path-aliases - 在 Knip 中配置路径别名
• config-enable-plugins-explicitly - 显式启用框架插件
• config-run-without-config - 先在不使用配置的情况下运行，以获取基线
• config-separate-entry-project - 将入口文件与项目文件分开
• config-use-json-schema - 使用 JSON schema 验证配置
• config-use-negation-patterns - 使用否定模式进行排除
• config-use-production-mode - 使用生产模式分析要发布的代码

2. 入口点策略（严重）

• entry-add-dynamic-imports - 将动态导入目标添加为入口点
• entry-exclude-test-files - 从生产入口中排除测试文件
• entry-include-all-entry-points - 包含所有应用入口点
• entry-include-bin-scripts - 将二进制脚本包含为入口点
• entry-use-compilers - 使用编译器处理非标准文件类型
• entry-use-plugin-entries - 使用框架插件的入口点
• entry-verify-with-debug - 使用调试模式验证入口点

3. Workspace 与 Monorepo（高）

• workspace-configure-root-workspace - 显式配置根 workspace
• workspace-ignore-specific - 在需要时忽略特定 workspace
• workspace-isolate-for-strict - 隔离 workspace，以严格检查依赖
• workspace-list-cross-deps - 显式列出跨 workspace 依赖
• workspace-per-workspace-plugins - 按 workspace 配置插件
• workspace-use-workspace-globs - 使用 workspace glob，保持配置一致

4. 依赖分析（HIGH）

• deps-add-unlisted-deps - 将未列出的依赖项添加到 package.json
• deps-avoid-transitive-reliance - 避免依赖传递依赖项
• deps-configure-plugin-deps - 为工具专属依赖项配置插件
• deps-fix-files-first - 先修复未使用的文件，再处理依赖项
• deps-ignore-conditional-deps - 忽略按条件加载的依赖项
• deps-remove-obsolete-types - 移除过时的类型定义包

5. 导出检测（MEDIUM-HIGH）

• exports-check-class-members - 检查类成员中是否存在未使用的代码
• exports-enable-entry-exports - 为私有包启用入口导出检查
• exports-handle-reexports - 处理 barrel 文件中的重新导出
• exports-ignore-same-file - 忽略在同一文件中使用的导出
• exports-tag-public-api - 使用 JSDoc 标记公共 API 导出
• exports-trace-usage - 移除导出前追踪其使用情况
• exports-use-include-libs - 对基于类型的使用采用 include libs

6. CI 集成（MEDIUM）

• ci-add-to-pipeline - 将 Knip 添加到 CI 流水线
• ci-separate-production-check - 分开检查生产模式和默认模式
• ci-use-cache - 启用缓存以加快 CI 运行速度
• ci-use-max-issues - 使用 max issues 逐步采用
• ci-use-reporters - 为 CI 输出使用合适的报告器
• ci-watch-mode-local - 在本地开发中使用监视模式

7. 自动修复工作流（MEDIUM）

• fix-allow-remove-files - 明确允许移除文件
• fix-format-after-fix - 自动修复后格式化代码
• fix-review-before-commit - 提交前检查自动修复的更改
• fix-update-deps-after - 修复依赖项后更新包管理器
• fix-use-fix-type - 使用 fix type 进行针对性清理

8. 性能优化（LOW-MEDIUM）

• perf-filter-issue-types - 筛选问题类型以便进行有针对性的分析
• perf-limit-output - 限制大型代码库的输出
• perf-profile-performance - 对运行缓慢的分析进行性能分析
• perf-use-bun-runtime - 使用 Bun 运行时加快分析速度
• perf-use-cache-flag - 启用缓存以重复执行分析
• perf-use-workspace-filter - 筛选工作区以加快 monorepo 分析

使用方法

阅读各个参考文件，了解详细说明和代码示例：

• 章节定义 - 类别结构和影响级别
• 规则模板 - 添加新规则的模板

参考文件

文件	描述
references/_sections.md	类别定义和排序
assets/templates/_template.md	新规则模板
metadata.json	版本和参考信息