npm install xxxx -legacy-peer-deps命令是什麼？

npm install xxxx –legacy-peer-deps命令是什麼？

摘要：帶著好奇心，研究學習了一番npm install xxxx –legacy-peer-deps命令是什麼？為什麼可以解決下載時候產生的依賴衝突呢？

本文分享自華為雲社區《npm install xxxx –legacy-peer-deps命令是什麼？為什麼可以解決下載時候產生的依賴衝突呢？》，作者： gentle_zhou 。

在日常使用命令npm install / npm install XX下載依賴的操作中，我經常會遇到無法解析依賴樹的問題（依賴衝突）：

但是每當遇到這種情況的時候，我用命令npm install –legacy-peer-deps就可以順利進行下載操作：

這是為什麼呢？帶著好奇心，我去研究學習了一番npm install xxxx –legacy-peer-deps命令是什麼？為什麼可以解決下載時候產生的依賴衝突呢？（註：我本地當前正在使用的npm版本是8.6.0）

本文導航：什麼是peerDependency？；npm install xxxx –legacy-peer-deps命令是什麼？為什麼可以解決下載時候產生的依賴衝突呢？；參考資料。

什麼是peerDependency？

我們日常在前端項目開發過程中，見到最多的一定是package.json文件里的devDependencies（用於在開發環境下依賴的模組）和dependencies（無論開發環境還是生產環境都需要的依賴模組）這兩個欄位（感興趣的小夥伴可以看我這篇文章：package.json文件里的dependencies和devDependencies有什麼區別嗎？）。

那麼命令–legacy-peer-dep里的peerDependency是什麼依賴呢？根據geeksforgeeks網站里的定義：

Peer Dependencies: In package.json file, there is an object called as peerDependencies and it consists of all the packages that are exactly required in the project or to the person who is downloading and the version numbers should also be the same. That is the reason they were named as peerDependencies. The best example is 『react』 which is common in every project to run similarly.

翻譯一下就是說，在package.json文件中，存在一個叫做peerDependencies（對等依賴關係）的對象，它包含了項目里需要的所有的包或則用戶正在下載的版本號相同的所有的包（很繞，但意思就是對等依賴關係指定我們的包與某個特定版本的npm包兼容）；對等依賴關係最好的例子就是React，一個聲明式的創建用戶介面的JS庫。

那麼我們為什麼需要對等依賴關係呢？

假設我們現在有一個HelloHWCloud工程，已經在其根目錄下的package.json文件中的dependencies欄位里聲明了packageA作為依賴，而其下面有兩個項目app_A和app_B，它們也依賴packageA。如果我們用dependencies而不是peerDepenedencies來聲明，那麼npm install安裝完項目之後的依賴結構如下圖所示：

├── HelloHWCloud
│   └── node_modules
│       ├── packageA
│       ├── app_A
│       │   └── nodule_modules
│       │       └── packageA
│       └── app_B
│       │   └── nodule_modules
│       │       └── packageA

從上圖可以看出，packageA依賴包被安裝了3次，造成了2次安裝冗餘。

而如果採用peerDepenedency來下載，就可以避免這個核心依賴庫被重複下載的問題。還是上面那個場景，我們在項目app_A和app_B的package.json文件里的peerDependencies欄位聲明一下核心依賴庫packageA，然後在根目錄的package.json文件里的dependencies欄位也聲明一下packageA。接著再執行npm install，生成的依賴結構就會如下圖所示：

├── HelloHWCloud
│   └── node_modules
│       ├── packageA
│       ├── app_A
│       └── app_B

如上圖所示，packageA就只會被安裝一次。因此，npm 從版本v7開始，install就默認以peerDependencies的方式去下載了：

如果用戶在根目錄的package.json文件里顯式依賴了核心庫，那麼各個子項目里的peerDepenedencies聲明就可以忽略
如果用戶沒有顯式依賴核心庫，那麼就按照子項目的peerDepenedencies中聲明的版本將依賴安裝到項目根目錄里

而方式2就會導致一個問題：用戶依賴的包版本與各個子項目依賴的包版本相互不兼容，那麼就會報錯（無法解析依賴樹的問題（依賴衝突））讓用戶自行去修復，因而導致安裝過程的中斷。（因為是從npm v7引入的，因此npm v3-v6就不會發生這個錯誤）