Á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.
Um espaço de trabalho deve ter um arquivo pnpm-workspace.yaml em sua raiz. Um espaço de trabalho também pode ter um arquivo .npmrc em sua raiz.
Se você está buscando algo sobre gerenciamento de mono repositórios, talvez lhe interesse ver sobre 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. Você pode ler mais neste artigo sobre bit install, em inglês: Gerenciamento de dependências de mono repositórios sem dor utilizando Bit.
Protocolo do espaço de trabalho (espaço de trabalho:)
If link-workspace-packages 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.
Este protocolo é especialmente útil quando a opção link-workspace-packages é definida como 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:
