Pular para o conteúdo principal
Versão: Next

Á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.

dica

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:)​

Por padrão, o pnpm irá vincular pacotes do espaço de trabalho se os pacotes disponíveis corresponderem aos intervalos declarados. 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:~, ou workspace:^)
  • 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:

ProjectStarsMigration dateMigration commit
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Material UI2024-01-03a1263e3e5ef8d840252b4857f85b33caa99f471d
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Nuxt2022-10-1774a90c566c936164018c086030c7de65b26a5cb6
Vue 3.02021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
n8n2022-11-09736777385c54d5b20174c9c1fda38bb31fbf14b4
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Ember.js2023-10-18b6b05da662497183434136fb0148e1dec544db04
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
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