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

工作區

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

A workspace must have a pnpm-workspace.yaml file in its root. A workspace also may have an .npmrc in its root.

提示

If you are looking into monorepo management, you might also want to look into Bit. Bit 實際上使用的是 pnpm，不過它會自動執行許多動作，目前在 pnpm/npm/Yarn 管理的傳統工作區中，這些動作則需要手動執行。 There's an article about bit install that talks about it: Painless Monorepo Dependency Management with Bit.

工作區通訊協定 (workspace:)​

If link-workspace-packages is set to true, pnpm will link packages from the workspace if the available packages match the declared ranges. For instance, foo@1.0.0 is linked into bar if bar has "foo": "^1.0.0" in its dependencies and foo@1.0.0 is in the workspace. However, if bar has "foo": "2.0.0" in dependencies and foo@2.0.0 is not in the workspace, foo@2.0.0 will be installed from the registry. 這個行為會導致一些不確定性。

Luckily, pnpm supports the workspace: protocol. 使用此通訊協定時，pnpm 會拒絕解析除本機工作區套件之外的任何內容。 So, if you set "foo": "workspace:2.0.0", this time installation will fail because "foo@2.0.0" isn't present in the workspace.

This protocol is especially useful when the link-workspace-packages option is set to false. In that case, pnpm will only link packages from the workspace if the workspace: protocol is used.

透過別名參考工作區套件​

Let's say you have a package in the workspace named foo. Usually, you would reference it as "foo": "workspace:*".

If you want to use a different alias, the following syntax will work too: "bar": "workspace:foo@*".

發佈前，別名會轉換為標準的別名相依性。 The above example will become: "bar": "npm:foo@1.0.0".

透過相對路徑參考工作區套件​

在具有 2 個套件的工作區中：

+ packages
	+ foo
	+ bar

bar may have foo in its dependencies declared as "foo": "workspace:../foo". 發布前，這些規格會轉換為所有套件管理器都支援的標準版本規格。

發佈工作區套件​

When a workspace package is packed into an archive (whether it's through pnpm pack or one of the publish commands like pnpm publish), we dynamically replace any workspace: dependency by:

  • The corresponding version in the target workspace (if you use workspace:*, workspace:~, or workspace:^)
  • 相關聯的 SemVer 範圍 (適用於其他任何範圍類型)

So for example, if we have foo, bar, qar, zoo in the workspace and they all are at version 1.5.0, the following:

{
	"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：

For how to set up a repository using Rush, read this page.

For using Changesets with pnpm, read this guide.

疑難排解​

工作區相依性之間有循環時，pnpm 將無法保證程式碼以拓撲順序執行。 如果 pnpm 在安裝期間偵測到相依性循環，則將會產生一個警告。 如果 pnpm 能夠找出導致循環的相依性，則也會將其顯示。

If you see the message There are cyclic workspace dependencies, please inspect workspace dependencies declared in dependencies, optionalDependencies and 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
Novu2021-12-23f2ea61f7d7ac7e12db4c9e70767082841ed98b2b
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
Ember.js2023-10-18b6b05da662497183434136fb0148e1dec544db04
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