peerDependencies WARNING问题剖析

peerDependencies是npm一个比较早的概念，以前一直没有注意过，因为它主要是跟插件的开发相关，直到最近负责做一些插件开发，才接触到这个东西。

我们对dependencies和devDependencies应该都很熟悉了，但是除了它们两个以外，package.json里还可以配置一个叫peerDependencies的配置。

那么这个peerDependencies配置有啥作用呢？下面我们举个小例子：

假设我们当前的项目是MyProject，项目中有一些依赖，比方其中有一个依赖包PackageA，该包的package.json文件指定了对PackageB的依赖：

{
    "dependencies": {
        "PackageB": "1.0.0"
    }
}

如果我们在我们的MyProject项目中执行npm install PackageA, 我们会发现我们项目的目录结构会是如下形式：

MyProject
|- node_modules
   |- PackageA
      |- node_modules
         |- PackageB

那么在我们的项目中，我们能通过下面语句引入"PackageA"：

var packageA = require('PackageA')

但是，如果你想在项目中直接引用PackageB:

var packageA = require('PackageA')
var packageB = require('PackageB')

这是不行的，即使PackageB被安装过。因为Node只会在“MyProject/node_modules”目录下查找PackageB，它不会在进入PackageA模块下的node_modules下查找。

所以，为了解决这个问题，在MyProject项目package.json中我们必须直接声明对PackageB的依赖并安装。

但是，有时我们不用在当前项目中声明对PackageB的依赖就可以直接引用。

为什么在项目中不用声明就可以直接使用呢？这就是peerDependencies的作用了。

例如上面PackageA的package.json文件如果是下面这样：

{
    "peerDependencies": {
        "PackageB": "1.0.0"
    }
}

那么，它会告诉npm：如果某个package把我列为依赖的话，那么那个package也必需应该有对PackageB的依赖。

也就是说，如果你npm install PackageA，你将会得到下面的如下的目录结构：

MyProject
|- node_modules
   |- PackageA
   |- PackageB

因此，你可能注意到：在npm2中，即使当前项目MyProject中没有直接依赖PackageB，该PackageB包依然会安装到当前项目的node_modules文件夹中。

在npm2中，PackageA包中peerDependencies所指定的依赖会随着npm install PackageA一起被强制安装，所以不需要在宿主环境的package.json文件中指定对PackageA中peerDependencies内容的依赖。

但是在npm3中，peerDependencies的表现与npm2不同：

npm3中不会再要求peerDependencies所指定的依赖包被强制安装，相反npm3会在安装结束后检查本次安装是否正确，如果不正确会给用户打印警告提示。

就拿上面的例子来说，如果我们npm install PackageA安装PackageA时，你会得到一个警告提示说：

PackageB是一个需要的依赖，但是没有被安装。

在这里插入图片描述
这时，你需要手动的在MyProject项目的package.json文件指定PackageB的依赖。

发布了398 篇原创文章 · 获赞 182 · 访问量 37万+