跳到主要内容
版本:10.x

工作空间

pnpm 内置支持 monorepositories(又称多包仓库、多项目仓库或单体仓库)。您可以创建一个工作空间来将多个项目统一到单个代码仓库中。

工作空间的根目录必须有一个 pnpm-workspace.yaml 文件。

提示

如果你正在寻找 monorepo 管理方案,不妨也看看 Bit。 Bit 在底层使用 pnpm,但自动化了许多在传统的由 pnpm/npm/Yarn 管理的工作空间中需要手动完成的事情。这篇关于 bit install 的文章详细介绍了这一点:使用 Bit 实现无痛的 Monorepo 依赖管理

工作空间协议 (workspace:)

如果将 linkWorkspacePackages 设置为 true,当可用包与声明的版本范围匹配时,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",安装将会失败。

linkWorkspacePackages 选项设置为 false 时,这个协议特别有用。在这种情况下,pnpm 只会在使用 workspace: 协议时链接工作空间中的包。

通过别名引用工作空间包

假设你在工作空间中有一个名为 foo 的包。通常情况下,你会这样引用它:"foo": "workspace:*"

如果你想使用一个不同的别名,下面的语法也是可行的:"bar": "workspace:foo@*"

发布之前,别名会被转换为常规的别名依赖。上面的例子会变成:"bar": "npm:foo@1.0.0"

通过相对路径引用工作空间包

在一个包含 2 个包的工作空间中:

+ packages
+ foo
+ bar

bar 可以在其依赖中通过 "foo": "workspace:../foo" 来声明 foo。在发布之前,这些规范会被转换为所有包管理器都支持的常规版本规范。

发布工作空间包

当工作空间包被打包成归档文件时(无论是通过 pnpm pack 还是诸如 pnpm publish 之类的发布命令),我们会动态地将任何 workspace: 依赖替换为:

  • 目标工作空间中的对应版本(如果你使用 workspace:*workspace:~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"
}
}

此功能允许你依赖本地工作空间包,同时仍然能够将结果包发布到远程注册表,而无需中间发布步骤 —— 你的用户将能够像使用任何其他包一样使用你发布的工作空间,同时仍然享受语义化版本带来的保证。

发布工作流程

在工作空间内为包进行版本管理是一项复杂的任务,目前 pnpm 并没有提供内置的解决方案。不过,有 2 个经过充分测试且支持 pnpm 的工具:

关于如何使用 Rush 设置代码仓库,请阅读此页面

关于如何在 pnpm 中使用 Changesets,请阅读此指南

故障排除

如果工作空间依赖之间存在循环,pnpm 无法保证脚本会按拓扑顺序运行。如果 pnpm 在安装过程中检测到循环依赖,它会产生一个警告。如果 pnpm 能够找出哪些依赖导致了循环,它也会显示出来。

如果你看到 There are cyclic workspace dependencies(存在循环工作空间依赖)这条消息,请检查在 dependenciesoptionalDependenciesdevDependencies 中声明的工作空间依赖。

使用示例

以下是一些使用 pnpm 工作空间功能的最受欢迎的开源项目:

项目Stars迁移日期迁移提交
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Material UI2024-01-03a1263e3e5ef8d840252b4857f85b33caa99f471d
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Nuxt2022-10-1774a90c566c936164018c086030c7de65b26a5cb6
Vue2021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
n8n2022-11-09736777385c54d5b20174c9c1fda38bb31fbf14b4
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
Novu2021-12-23f2ea61f7d7ac7e12db4c9e70767082841ed98b2b
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Quasar Framework2024-03-137f8e550bb7b6ab639ce423d02008e7f5e61cbf55
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
Stimulus Components2024-10-268e100d5b2c02ad5bf0b965822880a60f543f5ec3
Serenity/JS2025-01-0143dbe6f440d8dd81811da303e542381a17d06b4d