聊聊 node.js 中各類 dependency

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 結構是值得探討的一個話題，但願今天本文能對你有所幫助和啓發。