跳至主要內容
版本:7.x

工作區

pnpm 內建了對 Monorepo (單一存放庫,又稱為多重套件存放庫、多重專案存放庫或整合型存放庫) 的支援。 您可以建立一個工作區來將多個專案結合在一個單一存放庫的內部。

工作區的根目錄中必須具有 pnpm-workspace.yaml 檔。 工作區的根目錄中也可能會具有 .npmrc

提示

如果您要研究 monorepo 管理,那麽您還可能想要研究 Bit。 Bit 實際上使用的是 pnpm,但是它會自動執行許多目前在由 pnpm/npm/Yarn 所管理的傳統工作區中需要手動執行的動作。 有一篇有關 bit install 的文章提到這些:用 Bit 輕鬆管理單一存放庫相依性 (英文網頁)。

工作區通訊協定 (workspace:)

預設情況下,如果可用的套件與已宣告的範圍相符,pnpm 將會連接工作區中的套件。 例如,如果 bar 在其依賴項中有 "foo": "^1.0.0" 並且 foo@1.0.0 在 Workspace 中,則 foo@1.0.0 連接到 bar。 但是,如果 bar 在依賴項中有 "foo": "2.0.0" 並且 foo@2.0.0 不在工作區中,則將從 npm registry 中安裝 foo@2.0.0。 這種行為引入了一些不確定性。

幸運的是,pnpm 支持 workspace: 協議。 當使用此通訊協定時, pnpm 將拒絕解析除本地 workspace 包含的 package 之外的任何內容。 因此,如果您設置為 "foo": "workspace:2.0.0" 時,安裝將會失敗,因為 "foo@2.0.0" 不存在於此 workspace 中。

link-workspace-packages 選項被設定為 false 時,這個通訊協定將特別有用。 這種情況下,只有使用 workspace: 通訊協定聲明依賴,pnpm 才會從此 workspace 連接所需的包。

通過別名引用 Workspace 套件

假設您在 Workspace 中有一個名為 foo的套件。 通常,您會將其引用為 "foo": "workspace:*"

如果您想使用不同的別名,也可以使用以下語法: "bar": "workspace:foo@*"

在發佈之前,別名將轉換為常規的別名依賴項。 上面的示例將變為: "bar": "npm:foo@1.0.0"

通過相對路徑引用 Workspace 套件

在具有 2 個套件的 Workspace 中:

+ packages
+ foo
+ bar

bar 可能在其依賴項中具有 foo,聲明為 "foo": "workspace:../foo"。 在發佈之前,這些規範將轉換為所有包管理器支援的常規版本規範。

發佈 Workspace 套件

當一個 Workspace 套件被打包為一個檔案時(無論是通過 pnpm pack 或是像 pnpm publish 這樣的發布命令),我們會動態地替換所有 workspace: 依賴項:

  • 目標 workspace 中的對應版本(如果使用 workspace:*, workspace:~, or workspace:^
  • 相關聯的 semver 範圍(適用於任何其他範圍類型)

看一個例子,假設我們的 workspace 中有 foobarqarzoo 並且它們的版本都是 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"
}
}

這個功能允許你發布轉化之後的套件到遠端,並且可以正常使用本地 workspace 中的套件,而不需要其它中間步驟。套件的使用者也可以像常規的套件那樣正常使用,且仍然受益於語義化版本規範。

發布流程

對 workspace 內的包進行版本控制是一項複雜的任務,pnpm 目前不提供內置解決方案。 但是,有 2 個經過充分測試的工具可以處理版本控制並支援 pnpm:

有關如何使用 Rush 設置 repository,請閱讀 本頁

有關如何將 Changesets 與 pnpm 配合使用,請閱讀 本指南

疑難排解

pnpm 無法保證在 Workspace 相依關係之間有循環時,會以拓蹼順序執行指令 。 如果 pnpm 在安裝期間偵測到循環相依關係,他會產生一則警告。 如果 pnpm 能夠找出導致循環的相依關係,則它也會顯示它們。

如果您看到消息 There are cyclic workspace dependencies,請檢查在 dependenciesoptionalDependenciesdevDependencies 中聲明的 workspace 依賴。

使用範例

以下是使用 pnpm workspace 功能的幾個最熱門的開放程式碼專案:

專案Stars遷移日遷移的Commit
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Vue 3.02021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
Verdaccio2021-09-219dbf73e955fcb70b0a623c5ab89649b95146c744
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
Cycle.js2021-09-21f2187ab6688368edb904b649bd371a658f6a8637
VueUse2021-09-25826351ba1d9c514e34426c85f3d69fb9875c7dd9
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
SvelteKit2021-09-26b164420ab26fa04fd0fbe0ac05431f36a89ef193
Milkdown2021-09-264b2e1dd6125bc2198fd1b851c4f00eda70e9b913
Vitest2021-12-13d6ff0ccb819716713f5eab5c046861f4d8e4f988
Logto2021-07-290b002e07850c8e6d09b35d22fab56d3e99d77043
Nhost2022-02-0710a1799a1fef2f558f737de3bb6cadda2b50e58f
Rollup plugins2021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
ByteMD2021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb
icestark2021-12-164862326a8de53d02f617e7b1986774fd7540fccd
VuePress 2.02022-04-23b85b1c3b39e80a8de92a7469381061f75ef33623
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721