核心内容摘要
视听盛宴，心之所向：中文字幕视频，打开世界的任意门
depcheck是Node.js 项目专属的依赖检测工具核心作用是静态分析项目代码与package.json自动找出未使用、缺失、冗余的依赖解决项目迭代中依赖臃肿装了没用、漏装依赖代码用了但没在package.json声明、生产 / 开发依赖放错位置等问题是清理项目依赖、优化package.json的常用工具。
简单说项目开发久了常会出现「装了依赖从没用到」「代码里用了某个包但忘了 npm install」的情况depcheck能一站式检测这些问题让依赖清单更干净减少安装耗时和项目体积。
depcheck 核心作用核心围绕package.json的dependencies生产依赖、devDependencies开发依赖、peerDependencies展开共 4 个核心能力都是实际开发中高频刚需检测未使用的依赖找出dependencies/devDependencies里声明了但项目代码中从未引用的包最核心功能检测缺失的依赖找出项目代码中实际用到了但package.json里未声明忘了装的包识别冗余的依赖配置比如peerDependencies里声明了但项目无需的包或重复声明的依赖校验依赖分类间接提醒是否把开发依赖如eslint、webpack误放到生产依赖或反之。
⚠️ 注意depcheck是静态分析工具无法检测运行时动态加载如require(${变量})、全局依赖、框架 / 插件自动引入的依赖可能出现少量误报后续会讲解决方法。
depcheck 基础用法开箱即用
安装方式支持全局安装推荐所有项目可直接用或局部安装适合项目协作写入开发依赖二选一即可# 全局安装推荐一次安装所有项目使用 npm install -g depcheck # 或 yarn 全局安装 yarn global add depcheck # 局部安装项目专属写入devDependencies适合团队协作 npm install depcheck --save-dev # 或 yarn 局部安装 yarn add depcheck -D
基础使用核心命令进入Node.js 项目根目录必须有package.json的目录直接执行命令即可无需任何配置# 全局安装后直接执行 depcheck # 局部安装后通过npm脚本执行需先在package.json的scripts中配置 # package.json 中添加scripts: { depcheck: depcheck } npm run depcheck # 或 yarn 执行 yarn depcheck # 临时使用无需安装通过npx直接调用适合偶尔检测 npx depcheck
核心输出解读执行后会直接打印检测结果分为 4 个核心模块一目了然以下是典型输出示例# depcheck 执行后的输出 Unused dependencies: # 未使用的生产依赖可直接npm uninstall 删除 - lodash - axios Unused devDependencies: # 未使用的开发依赖可直接删除 - sass-loader - types/node-old Missing dependencies: # 缺失的依赖代码里用了但没装需npm install 安装 - moment: ./src/utils/date.js # 标注了依赖的使用文件路径 - uuid: ./src/components/IDGenerator.js Missing devDependencies: # 缺失的开发依赖 - types/moment: ./src/utils/date.js关键操作建议未使用的依赖直接执行npm uninstall 包名删除清理臃肿缺失的依赖执行npm install 包名生产依赖或npm install 包名 --save-dev开发依赖补装。
depcheck 高级用法解决误报 / 定制检测实际开发中部分依赖是运行时使用如 Webpack 插件、Express 中间件depcheck静态分析无法识别会出现误报未使用此时需要通过「忽略依赖」「定制检测规则」解决以下是高频高级用法
忽略指定依赖解决误报核心通过--ignore-deps忽略生产依赖、--ignore-dev-deps忽略开发依赖参数指定无需检测的包多个包用逗号分隔# 忽略生产依赖lodash、axios忽略开发依赖webpack-cli depcheck --ignore-deps lodash,axios --ignore-dev-deps webpack-cli
指定检测的文件目录默认检测项目根目录下的所有文件可通过--dirs指定特定目录如只检测 src、lib减少检测范围# 只检测src和lib目录的依赖使用情况 depcheck --dirs src,lib
排除无需检测的目录通过--ignore-dirs排除无关目录如 node_modules、dist、build默认已排除可自定义# 排除test、mock目录不检测这些目录的依赖 depcheck --ignore-dirs test,mock
输出 JSON 格式方便脚本 / 工具处理通过--json参数将检测结果输出为 JSON 格式适合后续写脚本自动处理如批量删除未使用依赖# 输出JSON格式结果可重定向到文件保存 depcheck --json depcheck-result.json
配置文件统一管理规则推荐团队协作频繁使用的忽略规则、目录配置可在项目根目录创建配置文件无需每次写长命令支持 2 种配置方式二选一方式 1创建.depcheckrc文件JSON 格式{ ignoreDeps: [lodash, axios], // 忽略的生产依赖 ignoreDevDeps: [webpack-cli, sass-loader], // 忽略的开发依赖 dirs: [src, lib], // 检测的目录 ignoreDirs: [test, mock, dist] // 排除的目录 }方式 2在package.json中添加depcheck字段{ name: your-project, depcheck: { ignoreDeps: [lodash], ignoreDevDeps: [webpack-cli] } }配置完成后直接执行depcheck会自动读取配置规则。
四、
常见问题与解决
依赖明明在用却被标记为「未使用」误报原因depcheck是静态分析无法识别动态加载如require(${name})、框架自动引入如 Vue 插件、React 高阶组件、运行时依赖如 Express 中间件。
解决通过上述「忽略依赖」的方式将误报的包加入忽略列表。
检测不到部分缺失的依赖原因代码中通过 CDN 引入、或全局安装的依赖depcheck无法检测。
解决这类依赖本身无需在package.json声明可忽略若为项目内局部使用需手动npm install并声明。
检测速度慢原因项目目录过大或包含大量无关文件。
解决通过--dirs指定核心代码目录--ignore-dirs排除 dist、node_modules、mock 等无关目录。