大家好，我是前端西瓜哥。最近在研究 React 源碼，用到了 yarn link 命令來(lái)鏈接兩個(gè)項(xiàng)目。

我對(duì)其底層原理產(chǎn)生了興趣，所以寫了這么一篇文章，希望能夠通過(guò)故事的形式，來(lái)讓大家理解 yarn link 的使用場(chǎng)景和用法。

另外 npm link 和 yarn link 的效果是相同的，下文就不提及 npm link 了。

有一天，小瓜維護(hù)的一個(gè)名為 xigua 的 NPM 包，被人提了 issue。小瓜看了下問題描述，憑著對(duì)項(xiàng)目的熟悉，他大概知道是哪里出了問題。

為了測(cè)試，小瓜搭建了一個(gè) demo-project 項(xiàng)目，且這個(gè)項(xiàng)目通過(guò) yarn add xiga 安裝了這個(gè)包，并在代碼中使用了它。

└── demo-project
    └── node_modules
        ├── apple
        └── xigua
            ├── old.js
            └── package.json

理論上，小瓜去這個(gè) demo-project 項(xiàng)目的 node_module/xigua 目錄下直接修改代碼就好了。

但不幸的是，里面的代碼是編譯出來(lái)的，無(wú)法直接修改。

小瓜于是跑到了 xigua-project 包的源碼項(xiàng)目中，運(yùn)行了一個(gè)可以監(jiān)聽源碼修改生成 npm 包內(nèi)容的命令。小瓜修改了一處代碼，然后自動(dòng)編譯到了 xigua-project/build/ 中。

└── xigua-project
    └── build
        └── xigua（編譯出來(lái)的文件夾）
            ├── fix.js
            └── package.json

然后小瓜就復(fù)制編譯好的代碼，覆蓋掉原來(lái)的demo-project/node_module/xigua ，然后看看效果不對(duì)。小瓜發(fā)現(xiàn)不對(duì)，再改，然后再?gòu)?fù)制，一連重復(fù)了好幾次。

“我受不了了，得想個(gè)辦法。”小瓜說(shuō)。每次編譯完都要手動(dòng)進(jìn)行復(fù)制操作，太搞人心態(tài)了。

機(jī)智的小瓜一番思考，最終想到了一個(gè)辦法。

1. 將 demo-project 下的 xigua 依賴包刪除
2. 然后創(chuàng)建一個(gè) xigua 軟鏈接文件，鏈接到 xigua-project 下的編譯文件夾（軟鏈接可以理解為快捷方式文件，可以將文件位置重定向）。

├── demo-project
│   └── node_modules
│       ├── apple
│       └── xigua（重定向） -> /xigua/build/node_modules/xigua
└── xigua-project
    └── build
        └── xigua（被鏈接的位置）
            ├── fix.js
            └── package.json

利用軟鏈接，我們將兩個(gè)項(xiàng)目關(guān)聯(lián)了起來(lái)。

yarn link

此時(shí)，舍友小潤(rùn)抱著他的猹路過(guò)了，猹是他的貓的名字。

小瓜正對(duì)自己的奇思妙想沾沾自喜，立馬向小潤(rùn)吹噓起來(lái)。

小潤(rùn)：“這個(gè)需求，包管理器是有相關(guān)命令支持的?！?/span>

小瓜：“居然有！展開說(shuō)說(shuō)怎么用?！?/span>

小潤(rùn)于是講解了起來(lái)。

其實(shí)很簡(jiǎn)單，我們進(jìn)入到 xigua/build/xigua 目錄下，執(zhí)行 yarn link。

$ yarn link
yarn link v1.22.17
success Registered "xigua".
info You can now run `yarn link "xigua"` in the projects where you want to use this package and it will be used instead.
?  Done in 0.01s.

這樣，包管理工具就會(huì) 在全局注冊(cè)一個(gè)名為 xiuga 的鏈接。

具體就是創(chuàng)建一個(gè) xigua 軟鏈接文件，指向這個(gè) xigua 目錄。在 macOS 中，是在 ~/.config/yarn/link/xigua 目錄下。

鏈接指向如下：

~/.config/yarn/link/xigua  ->  /xigua-project/build/xigua

更準(zhǔn)確來(lái)說(shuō)，yarn link 是會(huì)從當(dāng)前工作目錄往上找第一個(gè)有正確 package.json 文件的目錄，作為鏈接的對(duì)象，因?yàn)?npm 包里必須要有 package.json。

接下來(lái)我們?cè)倥艿?demo-project 項(xiàng)目的目錄下，執(zhí)行 yarn link xigua。

$ yarn link xigua
yarn link v1.22.17
success Using linked package for "xigua".
?  Done in 0.01s.

它會(huì)做兩個(gè)操作：

1. 將 demo-project 下的 xigua 依賴包刪除。
2. 然后創(chuàng)建一個(gè) xigua 軟鏈接文件，鏈接到 yarn/link/xigua。形成 demo-project -> yarn/link -> xigua-project的鏈。

小瓜震驚了：“這操作不就和我的做法一樣嗎？不過(guò)多了一個(gè) 中間人 yarn”。

是的，但 yarn 更方便。

yarn unlink

你在 demo-project 測(cè)試完了，想要斷開鏈接，此時(shí)需要執(zhí)行：

$ yarn unlink xigua
yarn unlink v1.22.17
success Removed linked package "xigua".
info You will need to run `yarn install --force` to re-install the package that was linked.
?  Done in 0.01s.

斷開鏈接后，因?yàn)樵瓉?lái)的包刪掉并換了個(gè)鏈接文件，所以我們需要再把這個(gè)包裝回來(lái)，需要執(zhí)行 yarn install --force。

你說(shuō)我刪除 node_modules，然后再執(zhí)行 yarn 行不行。

可以，前提是你的 node_modules 沒有其他包的鏈接，否則的話會(huì)把其他包的鏈接也干掉。

如果要?jiǎng)h除全局的注冊(cè)的名為 xigua 的 link，需要進(jìn)入到被鏈接的目錄下，執(zhí)行 yarn unlink。

$ yarn unlink
yarn unlink v1.22.17
success Unregistered "xigua".
info You can now run `yarn unlink "xigua"` in the projects where you no longer want to use this package.
?  Done in 0.01s.

結(jié)尾

yarn link 的作用是幫助我們調(diào)試開發(fā)的 NPM 包。

因?yàn)槠胀?xiàng)目的依賴包安裝是從網(wǎng)絡(luò)下載安裝的，如果要使用本地編譯的 NPM 包，比較好的方式是刪掉依賴包，通過(guò)快捷方式來(lái)鏈接我們本地編譯包。

為了簡(jiǎn)化這一流程，yarn link 出現(xiàn)了，通過(guò)中間者的形式，來(lái)實(shí)現(xiàn)快速地 link 和 unlink。