跳到主要內容
版本：9.x

工作空間

pnpm 內建支援單一儲存庫 (又稱多套件儲存庫、多專案儲存庫或單體儲存庫)。您可以在單一儲存庫內建立工作空間，以統一多個專案。

工作空間必須在其根目錄中有一個 pnpm-workspace.yaml 檔案。工作空間也可以在其根目錄中有一個 .npmrc。

提示

如果您正在尋找單一儲存庫管理，您可能也想看看 Bit。Bit 在幕後使用 pnpm，但自動化了許多傳統由 pnpm/npm/Yarn 管理的工作空間中手動完成的事情。有一篇關於 bit install 的文章在討論它：使用 Bit 進行無痛的單一儲存庫依賴性管理。

工作區協定 (workspace:)​

預設情況下，如果可用的套件符合宣告的範圍，pnpm 會連結工作區中的套件。例如，如果 bar 在其依賴項中具有 "foo": "^1.0.0"，且工作區中有 foo@1.0.0，則會將 foo@1.0.0 連結到 bar。但是，如果 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 設定儲存庫，請閱讀 此頁面。

有關如何將 Changesets 與 pnpm 一起使用，請閱讀 此指南。

疑難排解​

如果工作區相依性之間有循環，pnpm 無法保證腳本將以拓撲順序執行。如果 pnpm 在安裝過程中偵測到循環相依性，它會產生警告。如果 pnpm 能找出哪些相依性導致循環，它也會顯示出來。

如果您看到訊息 There are cyclic workspace dependencies，請檢查在 dependencies、optionalDependencies 和 devDependencies 中宣告的工作區相依性。

使用範例​

以下是幾個最受歡迎的開源專案，它們使用 pnpm 的工作區功能

專案星星遷移日期遷移提交
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Material UI2024-01-03a1263e3e5ef8d840252b4857f85b33caa99f471d
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Nuxt2022-10-1774a90c566c936164018c086030c7de65b26a5cb6
Vue 3.02021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
n8n2022-11-09736777385c54d5b20174c9c1fda38bb31fbf14b4
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Ember.js2023-10-18b6b05da662497183434136fb0148e1dec544db04
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
Qwik2022-11-14021b12f58cca657e0a008119bc711405513e1ee9
VueUse2021-09-25826351ba1d9c514e34426c85f3d69fb9875c7dd9
SvelteKit2021-09-26b164420ab26fa04fd0fbe0ac05431f36a89ef193
Verdaccio2021-09-219dbf73e955fcb70b0a623c5ab89649b95146c744
Vercel2023-01-129c768b98b71cfc72e8638bf5172be88c39e8fa69
Vitest2021-12-13d6ff0ccb819716713f5eab5c046861f4d8e4f988
Cycle.js2021-09-21f2187ab6688368edb904b649bd371a658f6a8637
Milkdown2021-09-264b2e1dd6125bc2198fd1b851c4f00eda70e9b913
Nhost2022-02-0710a1799a1fef2f558f737de3bb6cadda2b50e58f
Logto2021-07-290b002e07850c8e6d09b35d22fab56d3e99d77043
Rollup plugins2021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
icestark2021-12-164862326a8de53d02f617e7b1986774fd7540fccd
ByteMD2021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb