工作空间（Workspace）
pnpm 内置了对单一存储库（也称为多包存储库、多项目存储库或单体存储库）的支持。你可以创建一个工作空间以将多个项目合并到一个仓库中。
一个工作空间必须在它的根目录有一个 pnpm-workspace.yaml 文件。
提示
如果你正在查看 monorepo 管理，那么你可能还希望查看 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:~或workspace:^） - 相关的语义化版本范围（对于任何其他范围类型）
没有版本范围的裸 workspace: 将被视为 workspace:*。
如此例，如果我们在工作空间中有 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"
}
}
这个功能允许你发布转化之后的包到远端，并且可以正常使用本地工作空间的包，而不需要其它中间步骤。包的使用者也可以像常规的包那样正常使用，且仍然可以受益于语义化版本。
发布工作流#
pnpm versions and releases workspace packages with
pnpm change and pnpm version -r. See
Release management.
These external tools also handle versioning and support pnpm:
有关如何使用 Rush 设置存储库，请阅读 此页面。
要使用 pnpm 的变更集，请阅读本指南。
问题排查#
如果工作空间依赖项之间存在循环，则 pnpm 无法保证脚本将按拓扑顺序运行。如果 pnpm 在安装过程中检测到循环依赖，则会提供一个 warning 警告。 If pnpm can find out which dependencies are causing the cycles, it will display them too.
If you see the message There are cyclic workspace dependencies, inspect workspace dependencies declared in dependencies, optionalDependencies and devDependencies.
Workspaces in the wild#
以下是几个使用了 pnpm 工作空间功能的最受欢迎的开源项目：
配置#
linkWorkspacePackages#
- 默认值： false
- 类型：true、false、deep
启用该选项后，本地可用的软件包将被链接到 node_modules 中而不是从注册源下载。这在 monorepo 中非常方便。如果你需要本地包也链接到子依赖项，可以使用 deep 设置。
否则，软件包将全部从注册源下载并安装。然而，工作空间包仍然可以通过使用 workspace: 范围协议进行链接。
仅当软件包的版本满足依赖范围时，才会链接。
injectWorkspacePackages#
- 默认值： false
- 类型：Boolean
启用所有本地工作区依赖项的硬链接，而不是符号链接它们。或者，可以使用 dependencyMeta[].injected 来实现，这允许有选择地为特定依赖项启用硬链接。
注意
Even if this setting is enabled, pnpm will prefer to deduplicate injected dependencies using symlinks, unless multiple dependency graphs are required due to mismatched peer dependencies. 此行为由 dedepeInjectedDeps 设置控制。
dedupeInjectedDeps#
- 默认值：true
- 类型：Boolean
启用此设置后， 注入的依赖项 将尽可能从工作区进行符号链接。如果依赖项和注入的依赖项引用相同的对等依赖项，则无需将注入的依赖项物理复制到依赖项的 node_modules 中，符号链接就足够了。
syncInjectedDepsAfterScripts#
添加于：v10.5.0
- 默认值：undefined
- 类型：String[]
注入的工作区依赖项是硬链接的集合，当文件的源发生变化时，它们不会添加或删除文件。这会导致需要构建的包出现问题（例如在 TypeScript 项目中）。
此设置是脚本名称的列表。当这些脚本中的任何一个在工作区包中执行时，内部注入的依赖项 node_modules 也将同步。
preferWorkspacePackages#
- 默认值： false
- 类型：Boolean
如果启用了此选项，工作空间中的本地 package 将优先于注册表，即使注册表中有了该 package 的新版本。
仅当工作区不使用 saveWorkspaceProtocol 时，此设置才有用。
sharedWorkspaceLockfile#
- 默认值：true
- 类型：Boolean
如果启用此选项，pnpm 会在工作空间的根目录中创建一个唯一的 pnpm-lock.yaml 文件。这也意味着工作区包的所有依赖项将
位于单个“node_modules”中（并符号链接到它们的包“node_modules”
文件夹以进行 Node 的模块解析）。
此选项的好处：
- 每个依赖都是一个单例
- 在 monorepo 中的安装更快
- 代码更改都在一个文件中、代码审查减少
注意
尽管所有依赖项都将硬链接到根 node_modules 中，但软件包只能访问 package.json 中声明的
，因此 pnpm 的严格性得以保留。这是上述软链接的效果。
saveWorkspaceProtocol#
- 默认值：rolling
- 类型：true、false、rolling
这个设置控制从工作空间中链接的 dependencies 如何添加至 package.json。
如果 foo@1.0.0 在工作空间中，在工作空间的另一个项目中运行 pnpm add foo，则 foo 会被按如下方式添加到依赖项字段。 savePrefix 设置也会影响规范的创建方式。
| saveWorkspaceProtocol | savePrefix | spec |
|---|---|---|
| false | '' |
1.0.0 |
| false | '~' |
~1.0.0 |
| false | '^' |
^1.0.0 |
| true | '' |
workspace:1.0.0 |
| true | '~' |
workspace:~1.0.0 |
| true | '^' |
workspace:^1.0.0 |
| rolling | '' |
workspace:* |
| rolling | '~' |
workspace:~ |
| rolling | '^' |
workspace:^ |
includeWorkspaceRoot#
- 默认值： false
- 类型：Boolean
在工作区中递归执行命令时，也在根工作区项目上执行它们。
ignoreWorkspaceCycles#
- 默认值： false
- 类型：Boolean
When set to true, no workspace dependency cycle warnings will be printed.
It also downgrades an ERR_PNPM_TASK_CYCLE from a recursive run to a warning.
The tasks in that cycle then have no guaranteed order relative to each other.
See Workspace task orchestration.
disallowWorkspaceCycles#
- 默认值： false
- 类型：Boolean
当设置为 true 时，如果工作区存在循环，安装将失败。
workspaceConcurrency#
- Default: the smaller of 4 and the number of available CPU cores
- 类型：Number
Controls how many workspace tasks run at once. See
--workspace-concurrency for details.
ignoreWorkspaceRootCheck#
- 默认值： false
- 类型：Boolean
Allow adding dependencies to the workspace root without passing
--ignore-workspace-root-check or -w.
ignoreWorkspaceRootCheck: true
failIfNoMatch#
- 默认值： false
- 类型：Boolean
当设置为 true 时，如果没有包与提供的过滤器匹配，CLI 将用非零代码退出。
例如，以下命令将以非零代码退出，因为工作区中不存在 bad-pkg-name：
pnpm --filter=bad-pkg-name test