npm-link

建立套件資料夾的符號連結

選擇 CLI 版本

概要

npm link [<package-spec>]

alias: ln

說明

這對於安裝自己的東西非常方便，這樣您就可以在其中工作並反覆測試，而無需持續重新建置。

套件連結是一個兩步驟的程序。

首先，在沒有參數的情況下，在套件資料夾中執行 npm link 將在全域資料夾 {prefix}/lib/node_modules/<package> 中建立一個符號連結，連結到執行 npm link 指令的套件。它還會將套件中的任何 bin 連結到 {prefix}/bin/{name}。請注意，npm link 使用全域前置詞 (請參閱 npm prefix -g 以取得其值)。

接下來，在其他一些位置，npm link package-name 將從全域安裝的 package-name 建立一個符號連結到目前資料夾的 node_modules/。

請注意，package-name 取自 package.json，而非來自目錄名稱。

套件名稱可以選擇性地加上範圍前置詞。請參閱 scope。範圍必須在 @ 符號之前，並在斜線之後。

在為 npm publish 建立 tarball 時，如果已連結的套件包含在 bundleDependencies 中，則會透過解析符號連結來將其「快照」到目前狀態。

例如

cd ~/projects/node-redis    # go into the package directory
npm link                    # creates global link
cd ~/projects/node-bloggy   # go into some other package directory.
npm link redis              # link-install the package

現在，對 ~/projects/node-redis 的任何變更都將反映在 ~/projects/node-bloggy/node_modules/node-redis/ 中。請注意，連結應指向套件名稱，而不是該套件的目錄名稱。

您也可以將兩個步驟簡化為一個步驟。例如，以較短的方式執行上述使用案例

cd ~/projects/node-bloggy  # go into the dir of your main project
npm link ../node-redis     # link the dir of your dependency

第二行等於執行

(cd ../node-redis; npm link)
npm link redis

也就是說，它首先建立一個全域連結，然後將全域安裝目標連結到專案的 node_modules 資料夾中。

請注意，在這種情況下，您指的是目錄名稱 node-redis，而不是套件名稱 redis。

如果您的連結套件有範圍 (請參閱 scope)，您的連結指令必須包含該範圍，例如

npm link @myorg/privatepackage

警告

請注意，以這種方式連結的套件相依性預設不會儲存到 package.json，因為假設連結是要取代一般非連結相依性。否則，例如，如果您相依於 redis@^3.0.1，並執行 npm link redis，它將以 file:../path/to/node-redis 取代 ^3.0.1 相依性，這可能不是您想要的！此外，如果其他使用者或開發人員的資料夾設定與您的資料夾設定不完全相同，他們在您的專案中會遇到問題。

如果您要將新的相依性新增為連結，您應該執行 npm install <dep> --package-lock-only 將其新增到相關的元資料。

如果您想要在 package.json 和 package-lock.json 檔案中儲存 file: 參照，您可以使用 npm link <dep> --save 這麼做。

工作區使用

npm link <pkg> --workspace <name> 會將相關套件連結為指定工作區的相依性。請注意，如果沒有衝突的相依性，它實際上可能會連結到父專案的 node_modules 資料夾。

npm link --workspace <name> 會建立指向指定工作區的全球連結。

設定

`儲存`

預設：true，除非使用 npm update，預設為 false
類型：布林值

將已安裝的套件儲存到 package.json 檔案中，作為相依性。

與 npm rm 指令一起使用時，會從 package.json 中移除相依性。

如果設定為 false，也會防止寫入 package-lock.json。

`儲存精確`

預設：false
類型：布林值

儲存在 package.json 中的相依性將使用精確版本進行設定，而不是使用 npm 的預設 semver 範圍運算子。

`全域`

預設：false
類型：布林值

在「全域」模式下執行，以便將套件安裝到 prefix 資料夾，而不是目前的作業目錄。請參閱資料夾，以進一步瞭解行為的差異。

套件會安裝到 {prefix}/lib/node_modules 資料夾，而不是目前的作業目錄。
bin 檔案會連結到 {prefix}/bin
man 頁面會連結到 {prefix}/share/man

`安裝策略`

預設值：hoisted
類型：hoisted、nested、shallow 或 linked

設定在 node_modules 中安裝套件的策略。hoisted（預設值）：在頂層安裝非重複的套件，並在目錄結構中視需要重複安裝。nested：在原地安裝，不提升。shallow（以前稱為 --global-style）僅在頂層安裝直接相依性。linked：在 node_modules/.store 中安裝，在原地連結，未提升。