node 项目中常见 dependency，devDependency，peerDependency，日常平凡开辟的时刻老是碰到，但就是没细相识过它们之间的异同，本日简朴深切一下，记录下来。

起首看下方的图，project-main 的 dependency 是 package-a，package-a 的 devDependency 是 package-a-1，别的，project-main 也有一个 devDependency 是 package-b：

├── project-main
    ├── package-a (dependency)
    │   └── package-a-1 (devDependency)
    └── package-b (devDependency)

// package.json
{
  "name": "project-main",
  "dependencies": {
    "package-a": "^1.0.0"
  },
  "devDependencies": {
    "package-b": "^1.0.0"
  }
}

在 project-main 下实行 npm install 以后，package-a 和 package-b 都会被装置，但 package-a-1 不会被装置，所以你在 project-main 的 node_modules 文件夹下找不到 package-c。

dependency 与 devDependency 的异同

这是 dependency 与 devDependency 的不同点之一。项目依靠的 package 的 devDependency 不会被装置，但本身的 devDependency 会被装置，而一切的 dependency 都会被装置。如果不想装置本身的 devDependency 就运用 npm install --production 这个指令来，如许的话 关于 project-main 来讲，它的 devDependency 也不会被装置了。

所以，在开辟一个 node 包时，要注意辨别什么时刻用 dependencies 什么时刻用 devDependencies，平常做测试、打包、ES6转ES5此类的事情所依靠的库就运用 devDependencies，而一般功用所依靠的包就运用 dependencies 声明。

> npm install react --save  // 做为 dependencies 装置
> npm install eslint --save-dev // 做为 devDependencies 装置

peerDependencies

照样拿上面的例子来讲，如果 project-main 依靠的 package-a 的 package.json 中声清楚明了 peerDependency 是 package-apeer@^1.0.0，而 project-main 中没有任何 package-apeer 的设置，此时在 project-main 下运用 npm3 实行 npm install，控制台就会告警 UNMET PEER DEPENDENCY package-apeer@^1.0.0，意义就是说运用到 package-a 的项目必需装置同时装置 package-apeer@^1.0.0 ，不然顺序就可能会有异常，而在 npm@1 和 npm@2 下，就不会报错而是自动把 package-apeer@^1.0.0 装置上，由于许多用户回响反映如许很疑心，我没声明这个包，你为何要给我装置呢？所以在 npm@3 中这个 peerDependencies 如果没装就变成了控制台告警。

别的的 dependency

实在 node 另有别的两种 dependency 设置。

bundleDependencies

它另有一个别号，bundledDependencies，这个设置的作用以下：

关于下面这个包 package-a

{
  "name": "package-a",
  "dependencies": {
    "react": "^15.0.0",
    "core-js": "^2.0.0",
    "lodash": "^4.0.0"
  },
  "bundleDependencies": [
    "react",
    "core-js"
  ]
}

在你的项目中运用 npm@3 装置 package-a 以后，项目的 node_modules 的文件构造：

├── node_modules
    ├── package-a
    │   └── react
    │   └── core-js
    └── loadsh

bundleDependencies 的作用就是在用户装置了 package-a 以后，将 package-a 所声明的依靠包汇总到 package-a 本身的 node_modules 下，便于用户治理，如果 package-a 中没有设置 bundleDepencies，在装置了 package-a 的项面前目今 node_modules 就会长如许：

├── node_modules
    ├── package-a
    ├── react
    ├── core-js
    └── loadsh

optionalDependencies

如果你的node项目依靠了一个包 package-optional，如果这个 package-optional 没有装置，你依然想让顺序一般实行，这个时刻 optionalDependencies 就异常合适你这个需求，optionalDependencies 跟 dependencies 声明体式格局完全一致，而且一个依靠如果同时在 dependencies 和 optionalDependencies 中声明，option 还会掩盖 dependency 的声明。如果 package-optional 这个包是可选的，在代码中就能够如许写了：

try {
    var pkgOpt = require('package-optional');
} catch (e) {
    pkgOpt = null;
}
console.log(pkgOpt);

结语

node package 的依靠治理在现在的前端工程化时代背景下变得尤为重要，构建文雅可保护的 node_modules 构造是值得讨论的一个话题，愿望本日本文能对你有所协助和启示。