在前端开发中，我们经常会使用 npm 来管理项目的依赖。在使用 npm 安装依赖包时，有时候我们会遇到一些 peerDependency 的提示，这是因为项目依赖的某个包需要其它的包来提供支持，但这些包并不会被直接安装，而是需要手动安装。出于这个原因，我们可以使用 check-peer-dependencies 这个 npm 包来方便地检查 peerDependency 是否满足要求。本文将针对 check-peer-dependencies 进行详细的使用教程。
安装
npm i -D check-peer-dependencies
使用
命令行使用
check-peer-dependencies 的基本用法如下：
npx check-peer-dependencies
执行上面的命令会检查当前目录下的 package.json 文件中的所有 peerDependencies 是否满足要求。如果有未满足的依赖，控制台会输出如下提示信息：
[WARNING] Unmet peerDependencies found in: [WARNING] my-package@0.1.0: [WARNING] react@>=16.0.0 <17.x.x (found 17.0.2)
这里的 my-package@0.1.0 是指当前目录下的一个名为 my-package，版本号为 0.1.0 的包。根据上面的输出信息可以看出，my-package 这个包依赖于 react，但它要求的 react 的版本号必须是 >=16.0.0 <17.x.x，但我们安装的版本是 17.0.2，因此就会提示不满足要求。此时我们可以手动安装所需的 react 版本号，或修改 package.json 文件。
配置文件使用
check-peer-dependencies 还支持通过配置文件的方式来运行。在项目根目录下创建一个名为 .checkpeerdepsrc 的配置文件，内容格式如下：
-- -------------------- ---- ------- - ----------- - - ------- ------------- ------------------- - -------- --------- -------- - - - -展开代码
该配置文件表示在当前目录下，我们希望检查包名为 my-package 的包，其 peerDependencies 中必须满足 react 版本号必须是 >=16.0.0 <17.x.x。如果我们需要检查多个包，只需要在 packages 数组中添加相应的配置即可。
若想使用该配置文件，我们需要在命令行中添加 --config 或 -c 参数，例如：
npx check-peer-dependencies -c .checkpeerdepsrc
在 CI/CD 中的使用
在 CI/CD 环境下使用 check-peer-dependencies 会非常方便，可以保证 CI/CD 过程中依赖的正确性，并避免一些因版本差异导致的问题。
GitHub Actions
在 GitHub Actions 中使用 check-peer-dependencies 的方法如下：
-- -------------------- ---- ------- ----- -- --- ----- --------- - ---- - ----- ------ ----- ----- -------- ------------- ------ - ----- -------- ---- ----- ------------------- - ----- ------- ------------ ---- --- ------- - ----- ----- ---- ------------ ---- --- -----------------------展开代码
在上面的示例中，我们添加了一个 Check peer dependencies 的步骤，用于在每次 CI/CD 进程中检查依赖的正确性。
Travis CI
在 Travis CI 中使用 check-peer-dependencies 的方法如下：
-- -------------------- ---- ------- --- ----- --------- ------- -------- - ------- ----- -------- - ------ ---- ----- ---- ------- - --- ------- - --- -----------------------展开代码
同样地，在 Travis CI 中也可以添加一个 Check peer dependencies 的步骤，用于在每次 CI/CD 进程中检查依赖正确性。
总结
check-peer-dependencies 是一个非常实用的 npm 包，能够方便地帮助我们检查 peerDependency 是否满足要求，避免在开发、构建及部署等过程中出现问题。在使用 check-peer-dependencies 时，我们可以通过命令行或配置文件的方式来运行，也可以在 CI/CD 环境中使用。希望在今后的开发过程中，大家能够更好地使用它来保证项目的稳定性和正确性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/186199
