语言►nodejs►npm

什么是peerDependencies

本文作者: jsweibo

本文链接: https://jsweibo.github.io/2019/05/29/%E4%BB%80%E4%B9%88%E6%98%AFpeerDependencies/

摘要

本文主要讲述了：

  1. 背景
  2. 示例

正文

背景

考虑这样一种场景：

  1. 开发者针对example@2.0.0开发了一个名为example-plugin-a@1.0.0的插件
  2. example-plugin-a@1.0.0不需要引用example@2.0.0，两者不存在显式的依赖关系。但从逻辑上讲，example@2.0.0是example-plugin-a@1.0.0的宿主
  3. example-plugin-a@1.0.0不兼容example@1.0.0

为了避免用户在example@1.0.0的环境上安装example-plugin-a@1.0.0，显然此时开发者需要声明example-plugin-a@1.0.0和example@2.0.0的宿主关系。

于是peerDependencies应运而生。

peer 的中文意思为同辈的、同龄的。peerDependencies可以理解为同伴依赖，它表示包和包之间的宿主关系。

示例

grunt-babel是grunt的插件。

grunt-babel的peerDependencies为：

1
2
3
4
5
6
{
  "peerDependencies": {
    "@babel/core": "^7.0.0",
    "grunt": ">=0.4.0"
  }
}

我们可以新建一个项目来体验一下peerDependencies的作用，就像下文这样：

1
2
3
4
5
#!/usr/bin/env bash

mkdir learn_npm && cd learn_npm
npm init -y
npm install --save-dev grunt-babel

依赖安装完成之后，npm 会发出同伴依赖缺失的警告：

1
2
npm WARN grunt-babel@8.0.0 requires a peer of @babel/core@^7.0.0 but none is installed. You must install peer dependencies yourself.
npm WARN grunt-babel@8.0.0 requires a peer of grunt@>=0.4.0 but none is installed. You must install peer dependencies yourself.

参考资料

本文作者: jsweibo

本文链接: https://jsweibo.github.io/2019/05/29/%E4%BB%80%E4%B9%88%E6%98%AFpeerDependencies/

本文对你有帮助？请支持我

支付宝
微信