SuperAPI AI 工具集

knip

编程与开发

查看项目

更新于 11-15 11:53

技能介绍

用途

knip 技能用于在当前代码库中运行 knip,查找并清理未使用的文件、依赖(dependencies/devDependencies)和导出,适用于清理死代码与无用依赖的场景。

主要能力

  • 检查 knip 是否可用:运行 npx knip --version 测试;若失败或很慢,检查 package.json 的 devDependencies 是否已含 knip。
  • 未本地安装时按锁文件对应的包管理器安装,如 npm install -D knip(或 pnpm/yarn/bun 等价命令)。
  • 查找项目范围内的未使用文件、依赖与导出。
  • 提供 --production 模式,仅关注生产代码,排除测试文件、配置文件等非生产入口。
  • 支持自动修复:npx knip --fix 移除未使用导出与依赖;npx knip --fix --allow-remove-files 额外允许删除文件。
  • 支持 --reporter json 输出,便于程序解析。

使用方式

技能要求遵循“配置优先”的工作流,即使用户只是简单要求“运行 knip”,也应先完成配置再处理报告的问题:

  1. 了解项目:查看 package.json 确认框架与工具;检查是否存在 knip.json、knip.jsonc 或 package.json 中的 knip 配置项;若已有配置则审查改进。
  2. 运行 npx knip,优先阅读输出顶部的配置提示,这些提示建议调整配置以减少误报。
  3. 通过调整 knip.json 处理配置提示,如为检测到的框架启用/禁用插件、为非标准入口添加 entry 模式、为 monorepo 配置 workspace。
  4. 重复步骤 2-3,直到配置提示解决、误报最少。
  5. 处理实际问题,优先级依次为:未使用文件(先做,最降噪)、未使用依赖、未使用 devDependencies、未使用导出(删除或标记为 internal)、未使用类型。
  6. 每批修复后重新运行 knip,因为删除未使用文件常会暴露新的未使用导出与依赖。

配置最佳实践:不使用 ignore 模式(ignore 会隐藏真实问题);大量未使用导出类型时可加 ignoreExportsUsedInFile: { interface: true, type: true };移除冗余模式(knip 已遵循 .gitignore,无需再忽略 node_modules、dist、build、.git);移除默认插件已覆盖的 entry 模式;配置文件被报未使用(如 vite.config.ts)应显式启用或禁用对应插件而非忽略;与 Node.js 内置模块同名的依赖(如 buffer、process)加入 ignoreDependencies;路径别名导致的未解析导入可在配置中补充 paths(遵循 tsconfig.json 语义)。

清理置信度:可自动删除的高置信项包括明显为内部用途的未使用导出、未使用类型导出、未使用依赖、明显孤立的未使用文件;需先询问的包括可能是入口或被动态导入的文件、可能是公共 API 的导出(index.ts、lib 导出)、可能通过 CLI 或 peer dependencies 使用的依赖,以及 src/index、lib/ 路径或名称含 public、api 的文件,删除前应使用 AskUserQuestion 工具确认。

自动修复应在配置工作流完成且对结果有信心后进行,仅使用 --fix 与 --fix --allow-remove-files。

错误处理:若 knip 以退出码 2 结束(如“error loading file”),检查是否存在配置文件,没有则在项目根目录创建 knip.json;查阅 knip.dev 的已知问题与配置参考排查语法或选项错误,修复后重新运行。

适用场景

  • 清理代码库中的死代码和未使用依赖。
  • 在 monorepo 中排查未使用文件、依赖与导出(可能需要 --workspace 标志)。
  • 只关注生产代码的依赖与导出清理(--production)。

限制

  • knip 不处理文件内部的未使用导入与变量,这属于 linter 职责,应使用 ESLint 或 Biome。
  • 部分框架需要在配置中启用插件才能正确检测。
  • monorepo 可能需要 --workspace 标志。
  • 涉及可能的入口文件、公共 API 导出或可能通过 CLI/peer dependencies 使用的依赖时,应先询问确认,不宜自动删除。