工作區
pnpm 內建了對 Monorepo (單一存放庫,又稱為多重套件存放庫、多重專案存放庫或整合型存放庫) 的支援。 您可以建立一個工作區來將多個專案結合在單個存放庫的內部。
工作區的根目錄中必須具有 pnpm-workspace.yaml
檔。 工作區的根目錄中也可能會具有 .npmrc
。
如果您要研究 Monorepo 管理,那 麽您還可能想要研究 Bit (英文網頁)。 Bit 實際上使用的是 pnpm,不過它會自動執行許多動作,目前在 pnpm/npm/Yarn 管理的傳統工作區中,這些動作則需要手動執行。 有一篇 bit install
方面的文章提到了這些:〈用 Bit 輕鬆管理 Monorepo 依賴套件〉(英文網頁)。
工作區通訊協定 (workspace:)
If link-workspace-packages is set to true
, pnpm will link packages from the workspace if the available packages match the declared ranges. 例如,若 bar
的相依性中具有 "foo": "1.0.0"
,且 foo@1.0.0
位於工作區,則會在 bar
中建立 foo@1.0.0
的連結。 不過,若 bar
的相依性中具有 "foo": "2.0.0"
,且 foo@2.0.0
不位於工作區,則將會從登錄檔中安裝 foo@2.0.0
。 這個行為會導致一些不確定性。
幸好,pnpm 支援 workspace:
通訊協定。 使用此通訊協定時,pnpm 會拒絕解析除本機工作區套件之外的任何內容。 因此,如果您設定 "foo": "workspace:2.0.0"
,此次會安裝失敗,因為 "foo@2.0.0"
不在工作區中。
當 link-workspace-packages 選項設定為 false
時,這個通訊協定會特別有用。 在這種情況下,若使用 workspace:
通訊協定,則 pnpm 僅會建立工作區中套件的連結。
透過別名參考工作區套件
假設您的工作區中有一個名為 foo
的套件。 通常,您會參考它作為 "foo": "workspace:*"
。
如果您想使用其他別名,以下語法也可以運作: "bar": "workspace:foo@*"
。
發佈前,別名會轉換為標準的別名相依性。 上述範例會變成:"bar": "npm:foo@1.0.0"
。
透過相對路徑參考工作區套件
在具有 2 個套件的工作區中:
+ packages
+ foo
+ bar
bar
可能在其相依性中具有 foo
,宣告為 "foo": "workspace:.../foo"
。 發布前,這些規格會轉換為所有套件管理器都支援的標準版本規格。
發佈工作區套件
當工作區套件封裝於封存檔中時 (不論是透過 pnpm pack
或是其中一個發佈命令如 pnpm publish
),我們會將所有的 workspace:
相依性替換為:
- 目標工作區中的對應版本 (如果您使用
workspace:*
、workspace:~
或workspace:^
) - 相關聯的 SemVer 範圍 (適用於其他任何範圍類型)
舉例來講,如果我們的工作區中具有 foo
、bar
、qar
、zoo
,且全都是 1.5.0
版本,則以下內容:
{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:~",
"qar": "workspace:^",
"zoo": "workspace:^1.5.0"
}
}
會轉換為:
{
"dependencies": {
"foo": "1.5.0",
"bar": "~1.5.0",
"qar": "^1.5.0",
"zoo": "^1.5.0"
}
}
這個功能允許您在相依於本機工作區的套件時,仍然能夠將產生的套件發佈至遠端登錄檔,而無須中繼的發佈步驟。您的消費者將能夠將發佈的工作區像其他任何套件一樣使用,仍然得益於 SemVer 提供的保證。
釋出工作流程
對工作區內的套件進行版本設定是一項複雜的工作,pnpm 目前不為此提供內建解決方案。 不過,有 2 個經過充分測試的工具可以處理版本設定且支援 pnpm:
有關如何使用 Rush 設置 repository,請參閱這個頁面 (簡體中文網頁)。
有關如何將 Changesets 與 pnpm 配合使用,請參閱這個指南。
疑難排解
工作區相依性之間有循環時,pnpm 將無法保證程式碼以拓撲順序執行。 如果 pnpm 在安裝期間偵測到相依性循環,則將會產生一個警告。 如果 pnpm 能夠找出導致循環的相依性,則也會將其顯示。
如果您看到 There are cyclic workspace dependencies
的訊息,則請檢查在 dependencies
、optionalDependencies
和 devDependencies
中宣告的工作區相依性。
使用範例
以下是使用 pnpm 工作區功能的幾個最熱門的開源專案: