转载

聊聊 node.js 中各种 dependency

node 项目中常见 dependency ， devDependency ， peerDependency ，平时开发的时候总是遇到，但就是没细了解过它们之间的异同，今天简单深入一下，记录下来。

首先看下方的图，package-a 的 dependency 是 package-b，package-b 的 devDependency 是 package-c，此外，package-a 还有一个 devDependency 是 package-d：

package-a

--- package-b (dependency)

--- | --- package-c (devDependency)

--- package-d (devDependency)

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

当在 package-a 的文件夹下执行 npm install 之后，package-b、package-d 会被安装，但 package-c 不会被安装，所以你在 package-a 的 node_modules 文件夹下找不到 package-c。

dependency 与 devDependency 的异同

这是 dependency 与 devDependency 的不同点之一：顶层的 package 所依赖的子 package 的 devDependency 不会被安装，但自身的 devDependency 会被安装，而所有的父子的 dependency 都会被安装。如果不想安装自身的 devDependency 就使用 npm install --production 这个指令来，这样的话 package-d 也不会被安装了。

所以，在开发一个 node 包时，要注意区分什么时候用 dependencies 什么时候用 devDependencies，一般做测试、打包、ES6转ES5此类的工作所依赖的库就使用 devDependencies，而正常功能所依赖的包就使用 dependencies 声明。

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

peerDependencies

还是拿上面的例子来说，假如 package-b 的 package.json 中声明了 peerDependency 是 package-bpeer@^1.0.0 ，而 package-a 中没有任何 package-bpeer 的声明，此时在 package-a 下使用 npm3 执行 npm install ，控制台就会报错 UNMET PEER DEPENDENCY package-bpeer@^1.0.0 ，意思就是说使用到 package-b 的项目必须安装 package-bpeer@^1.0.0 ，否则程序就可能会有异常，而在 npm@1 和 npm@2 下，就不会报错而是自动把 package-bpeer@^1.0.0 安装上，因为很多用户觉得这样很困惑，我没声明这个，你为什么给我安装呢？所以在 npm@3 中这个 peerDependencies 如果没装就变成了控制台告警。

其它的 dependency

其实 node 还有两个其它类型的 dependency 配置。

bundleDependencies

它还有一个别名，bundledDependencies，这个配置的作用如下：

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

在项目中使用 npm@3 安装 package-b 的 node_modules 的文件结构：

node_modules/
--- package-b/
--- | --- react/
--- | --- core-js/
--- loadsh/

bundleDependencies 的作用就是在用户安装了 package-b 之后，将所声明的依赖包汇总到 package-b/node_modules 下，便于用户管理。

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 结构是值得探讨的一个话题，希望今天本文能对你有所帮助和启发。

原文 https://segmentfault.com/a/1190000008398819

正文到此结束

所属分类：编程技术

本文标签： 配置开发安装 dependencies cat json 需求希望 js 代码 IO https Node.js http node 管理 core 测试 UI src
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

聊聊 node.js 中各种 dependency

dependency 与 devDependency 的异同

peerDependencies

其它的 dependency

bundleDependencies

optionalDependencies

结语

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流