Área de Trabalho
O pnpm tem suporte embutido para mono repositórios (também conhecidos como repositórios multi-pacotes, repositórios multi-projetos ou repositórios monolíticos). Você pode criar uma área de trabalho para unir vários projetos dentro de um único repositório.
A workspace must have a pnpm-workspace.yaml file in its root.
If you are looking into monorepo management, you might also want to look into Bit. Bit usa pnpm internamente e automatiza muitos de seus processos realizados manualmente em um espaço de trabalho tradicional gerenciado por pnpm/npm/Yarn. There's an article about bit install that talks about it: Painless Monorepo Dependency Management with Bit.
Protocolo do espaço de trabalho (espaço de trabalho:)
If linkWorkspacePackages is set to true, pnpm will link packages from the workspace if the available packages match the declared ranges. Por exemplo, foo@1.0.0 é vinculado a bar se bar possui "foo": "^1.0.0" como dependência e foo@1.0.0 existir em seu espaço de trabalho. No entanto, se bar possui "foo": "2.0.0" como dependência e foo@2.0.0 não existir no espaço de trabalho, foo@2.0.0 será instalado a partir do registro. Este comportamento introduz certas incertezas.
Felizmente, pnpm suporta o protocolo workspace:. Quando este protocolo é utilizado, o pnpm irá se recusar a realizar a resolução de pacote de outro modo que não seja por um pacote do espaço de trabalho local. Portanto, caso você definir "foo": "workspace:2.0.0", a instalação falhará, pois "foo@2.0.0" não está presente no espaço de trabalho.
This protocol is especially useful when the linkWorkspacePackages option is set to false. Nesse caso, o pnpm vinculará apenas pacotes do espaço de trabalho se o protocolo workspace: for utilizado.
Referenciando pacotes de áreas de trabalhos via aliases
Digamos que você tenha um pacote no espaço de trabalho chamado foo. Geralmente você o referenciaria como "foo": "workspace:*".
Se você quiser utilizar um alias, ou seja, chamar o pacote com um nome alternativo, a seguinte sintaxe também funcionará: "bar": "workspace:foo@*".
Antes da publicação, os aliases serão convertidos para seu nome de dependência de origem. O exemplo acima ficará: "bar": "npm:foo@1.0.0".
Referenciando pacotes de workspaces por meio de seu caminho relativo
In a workspace with 2 packages:
+ packages
+ foo
+ bar
bar may have foo in its dependencies declared as "foo": "workspace:../foo". Before publishing, these specs are converted to regular version specs supported by all package managers.
Publicando pacotes de workspaces
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:
- A versão correspondente da workspace de destino (se você usa
workspace:*,workspace:~, ouworkspace:^) - O intervalo semver associado (para qualquer outro tipo de intervalo)
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"
}
}
Will be transformed into:
{
"dependencies": {
"foo": "1.5.0",
"bar": "~1.5.0",
"qar": "^1.5.0",
"zoo": "^1.5.0"
}
}
This feature allows you to depend on your local workspace packages while still being able to publish the resulting packages to the remote registry without needing intermediary publish steps - your consumers will be able to use your published workspaces as any other package, still benefitting from the guarantees semver offers.
Release workflow
Versioning packages inside a workspace is a complex task and pnpm currently does not provide a built-in solution for it. However, there are 2 well tested tools that handle versioning and support pnpm:
For how to set up a repository using Rush, read this page.
For using Changesets with pnpm, read this guide.
Troubleshooting
pnpm cannot guarantee that scripts will be run in topological order if there are cycles between workspace dependencies. If pnpm detects cyclic dependencies during installation, it will produce a warning. If pnpm is able to find out which dependencies are causing the cycles, it will display them too.
If you see the message There are cyclic workspace dependencies, please inspect workspace dependencies declared in dependencies, optionalDependencies and devDependencies.
Exemplos de uso
Here are a few of the most popular open source projects that use the workspace feature of pnpm:
Configuração
linkWorkspacePackages
- Padrão: low
- Tipo: true, false, deep
If this is enabled, locally available packages are linked to node_modules instead of being downloaded from the registry. This is very convenient in a monorepo. If you need local packages to also be linked to subdependencies, you can use the deep setting.
Else, packages are downloaded and installed from the registry. However, workspace packages can still be linked by using the workspace: range protocol.
Packages are only linked if their versions satisfy the dependency ranges.
injectWorkspacePackages
- Padrão: low
- Tipo: Boolean
Enables hard-linking of all local workspace dependencies instead of symlinking them. Alternatively, this can be achieved using dependenciesMeta[].injected, which allows to selectively enable hard-linking for specific dependencies.
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. This behaviour is controlled by the dedupeInjectedDeps setting.
dedupeInjectedDeps
- Valor padrão: false
- Tipo: Boolean
When this setting is enabled, dependencies that are injected will be symlinked from the workspace whenever possible. If the dependent project and the injected dependency reference the same peer dependencies, then it is not necessary to physically copy the injected dependency into the dependent's node_modules; a symlink is sufficient.
syncInjectedDepsAfterScripts
Added in: v10.5.0
- Padrão: ** undefined **
- Type: String[]
Injected workspace dependencies are collections of hardlinks, which don't add or remove the files when their sources change. This causes problems in packages that need to be built (such as in TypeScript projects).
This setting is a list of script names. When any of these scripts are executed in a workspace package, the injected dependencies inside node_modules will also be synchronized.
preferWorkspacePackages
- Padrão: low
- Tipo: Boolean
If this is enabled, local packages from the workspace are preferred over packages from the registry, even if there is a newer version of the package in the registry.
This setting is only useful if the workspace doesn't use saveWorkspaceProtocol.
sharedWorkspaceLockfile
- Valor padrão: false
- Tipo: Boolean
If this is enabled, pnpm creates a single pnpm-lock.yaml file in the root of the workspace. This also means that all dependencies of workspace packages will be in a single node_modules (and get symlinked to their package node_modules folder for Node's module resolution).
Advantages of this option:
- every dependency is a singleton
- faster installations in a monorepo
- fewer changes in code reviews as they are all in one file
Even though all the dependencies will be hard linked into the root node_modules, packages will have access only to those dependencies that are declared in their package.json, so pnpm's strictness is preserved. This is a result of the aforementioned symbolic linking.
saveWorkspaceProtocol
- Default: rolling
- Type: true, false, rolling
Essa configuração controla como as dependências vinculadas do workspace são adicionadas ao package.json.
Se foo@1.0.0 estiver no workspace e você executar pnpm add foo em outro projeto do workspace, veja abaixo como foo será adicionado ao campo de dependências. The savePrefix setting also influences how the spec is created.
| 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
- Padrão: low
- Tipo: Boolean
Ao executar comandos recursivamente em um workspace, também executa no projeto do workspace raiz.
ignoreWorkspaceCycles
- Padrão: low
- Tipo: Boolean
When set to true, no workspace cycle warnings will be printed.
disallowWorkspaceCycles
- Padrão: low
- Tipo: Boolean
When set to true, installation will fail if the workspace has cycles.
failIfNoMatch
- Padrão: low
- Tipo: Boolean
When set to true, the CLI will exit with a non-zero code if no packages match the provided filters.
For example, the following command will exit with a non-zero code because bad-pkg-name is not present in the workspace:
pnpm --filter=bad-pkg-name test