SuperAPI AI 工具集

knip-deadcode-best-practices

编程与开发

查看项目

更新于 10-16 03:46

技能介绍

用途:帮助在 JavaScript 和 TypeScript 项目中配置与使用 Knip 检测和清理死代码,适用于初始化 Knip 配置、排查误报漏报、搭建 CI 防回归、使用自动修复以及优化大型代码库分析性能等场景。

主要能力:以 43 条规则覆盖 8 个类别并按优先级排列。1)配置基础(CRITICAL,config-):避免宽泛 ignore、配置路径别名、显式启用插件、先无配置跑基线、区分入口与项目文件、用 JSON schema 校验、用否定模式排除、生产模式分析。2)入口点策略(CRITICAL,entry-):动态导入目标设为入口、排除测试文件、覆盖所有应用入口、包含二进制脚本、非标准类型用编译器、框架用插件入口、debug 模式验证。3)工作区与 monorepo(HIGH,workspace-):显式配置根工作区、忽略特定工作区、隔离以实现严格依赖检查、列出跨工作区依赖、按工作区配置插件、使用 workspace globs。4)依赖分析(HIGH,deps-):补录未声明依赖、避免依赖传递依赖、为工具依赖配置插件、先修未使用文件、忽略条件加载依赖、移除过时类型包。5)导出检测(MEDIUM-HIGH,exports-):检查类成员、私有包启用入口导出检查、处理 barrel 文件再导出、忽略同文件内使用、用 JSDoc 标记公共 API、移除前追踪使用、用 include libs 处理类型消费。6)CI 集成(MEDIUM,ci-):加入流水线、分离生产与默认模式检查、启用缓存、用 max issues 渐进采用、选择合适 reporter、本地用 watch 模式。7)自动修复(MEDIUM,fix-):显式允许删除文件、修复后格式化、提交前审查、依赖修复后更新包管理器、用 fix 类型定向清理。8)性能优化(LOW-MEDIUM,perf-):过滤问题类型、限制大代码库输出、性能剖析、使用 Bun 运行时、启用缓存标志、按工作区过滤。

使用方式:按需阅读各规则参考文件,仓库含 references/_sections.md(分类定义与排序)与 assets/templates/_template.md(新规则模板),metadata.json 提供版本与参考信息。具体命令、配置代码与代码示例在资料中暂未提供。

限制:本条目为社区整理的最佳实践指南,非 Knip 官方文档;资料未给出各规则的详细解释、代码示例和实际验证结果,实施时需结合项目实际情况判断。