Movatterモバイル変換


[0]ホーム

URL:


跳到主内容
版本:10.x

工作空间(Workspace)

pnpm 内置了对单一存储库(也称为多包存储库、多项目存储库或单体存储库)的支持。 你可以创建一个工作空间以将多个项目合并到一个仓库中。

一个工作空间必须在它的根目录有一个pnpm-workspace.yaml 文件。 工作区在其根目录中也可能有一个.npmrc

提示

如果你正在查看 monorpo 管理,那么你可能还希望查看Bit。Bit 在后台使用 pnpm,但将许多当前在由 pnpm/npm/Yarn 管理的传统工作区中手动完成的事情自动化。 有一篇关于bit install 的文章讨论了这一点:使用 Bit 进行无痛的 Monorepo 依赖管理

工作空间协议 (workspace:)

如果link-workspace-packages 设置为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"

link-workspace-packages 选项被设置为false 时,这个协议特别有用。 在这种情况下,如果使用workspace: 协议,pnpm 将仅链接来自工作区的包。

通过别名引用工作空间包

假设你在 workspace 中有一个名为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:^
  • 相关的语义化版本范围(对于任何其他范围类型)

如此例,如果我们在工作空间中有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 中的包版本管理是一个复杂的任务,pnpm 目前也并未提供内置的解决方案。 不过,有两个不错且支持 pnpm 的版本控制工具可以使用:

有关如何使用 Rush 设置存储库,请阅读此页面

要使用 pnpm 的变更集,请阅读本指南

问题排查

如果工作空间依赖项之间存在循环,则 pnpm 无法保证脚本将按拓扑顺序运行。 如果 pnpm 在安装过程中检测到循环依赖,则会提供一个 warning 警告。 如果 pnpm 能够找出导致循环的依赖项,也会将其展示出来。

如果你看到此消息There are cyclic workspace dependencies ,请检查在dependencies,optionalDependenciesdevDependencies 中声明的工作空间依赖。

使用示例

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

项目星星数迁移日期迁移提交
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 插件2021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
icestark2021-12-164862326a8de53d02f617e7b1986774fd7540fccd
ByteMD2021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb
Stimulus 组件2024-10-268e100d5b2c02ad5bf0b965822880a60f543f5ec3
Serenity/JS2025-01-0143dbe6f440d8dd81811da303e542381a17d06b4d

[8]ページ先頭

©2009-2025 Movatter.jp