Passer au contenu principal
Version : Suivant

Workspace

pnpm a un support intégré pour les monorepo (dépôts multi-package, dépôts multi-projets ou dépôts monolithiques). Vous pouvez créer un espace de travail pour unir plusieurs projets dans un seul référentiel.

Un espace de travail doit avoir un fichier pnpm-workspace.yaml dans sa racine. Un espace de travail peut également avoir un .npmrc dans sa racine.

astuce

Si vous êtes à la recherche d'une gestion monorepo, vous pouvez également consulter Bit. Bit utilise pnpm sous le capot mais automatise un tas de choses qui sont actuellement faites manuellement dans un espace de travail traditionnel géré par pnpm / npm / Yarn. Il y a un article sur bit install qui en parle : Painless Monorepo Dependency Management with Bit.

Protocole d'espace de travail (workspace:)​

Par défaut, pnpm liera les packages à partir de l'espace de travail si les packages disponibles correspondent aux plages déclarées. Par exemple, foo@1.0.0 est lié à bar si bar a "foo":"^1.0.0" dans ses dépendances et que foo@1.0.0 se trouve dans l'espace de travail. Toutefois, si bar a "foo": "2.0.0" dans les dépendances et foo@2.0.0 n’est pas dans l’espace de travail, foo@2.0.0 sera installé à partir du registre. Ce comportement introduit une certaine incertitude .

Heureusement, pnpm prend en charge le protocole workspace:. Lorsque ce protocole est utilisé, pnpm refuse de résoudre autre chose qu’un package de l'espace de travail local. Donc, si vous définissez "foo": "workspace:2.0.0", cette fois l'installation échouera car "foo@2.0.0" n'est pas présent dans l'espace de travail.

Ce protocole est particulièrement utile lorsque l'option link-workspace-packages est définie sur false. Dans ce cas, pnpm ne liera les packages de l'espace de travail que si le protocole workspace: est utilisé.

Référencement des packages de l'espace de travail via des alias​

Disons que vous avez un package dans l'espace de travail appelé foo. Habituellement, vous devez le référencer comme "foo": "workspace:*".

Si vous souhaitez utiliser un alias différent, la syntaxe suivante fonctionnera également : "bar": "workspace:foo@*".

Avant la publication, les alias sont convertis en dépendances alliacées standards. L'exemple ci-dessus deviendra : "bar": "npm:foo@1.0.0".

Référencement des packages de l'espace de travail via leur chemin relatif​

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.

Publishing workspace packages​

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:

  • The corresponding version in the target workspace (if you use workspace:*, workspace:~, or workspace:^)
  • The associated semver range (for any other range type)

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:

Pour savoir comment configurer un référentiel à l'aide de Rush, veuillez vous référer a cette page.

For using Changesets with pnpm, read this guide.

Dépannage​

pnpm ne peut garantir que les scripts seront exécutés en ordre topologique s'il existe des cycles entre les dépendances de l'espace de travail. Si pnpm détecte les dépendances cycliques pendant l'installation, il génère un avertissement. Si pnpm est capable de savoir quelles dépendances causent les cycles, elle les affichera aussi.

Si vous voyez le message There are cyclic workspace dependencies, vérifiez les dépendances de l'espace de travail déclarées dans dependencies, optionalDependencies et devDependencies.

Exemples d'utilisation​

Voici quelques-uns des projets open source les plus populaires qui utilisent la fonction d'espace de travail de pnpm :

ProjectStarsMigration dateMigration commit
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Nuxt2022-10-1774a90c566c936164018c086030c7de65b26a5cb6
Vue 3.02021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
n8n2022-11-09736777385c54d5b20174c9c1fda38bb31fbf14b4
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
Verdaccio2021-09-219dbf73e955fcb70b0a623c5ab89649b95146c744
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
VueUse2021-09-25826351ba1d9c514e34426c85f3d69fb9875c7dd9
SvelteKit2021-09-26b164420ab26fa04fd0fbe0ac05431f36a89ef193
Cycle.js2021-09-21f2187ab6688368edb904b649bd371a658f6a8637
Vercel2023-01-129c768b98b71cfc72e8638bf5172be88c39e8fa69
Vitest2021-12-13d6ff0ccb819716713f5eab5c046861f4d8e4f988
Milkdown2021-09-264b2e1dd6125bc2198fd1b851c4f00eda70e9b913
Nhost2022-02-0710a1799a1fef2f558f737de3bb6cadda2b50e58f
Logto2021-07-290b002e07850c8e6d09b35d22fab56d3e99d77043
ByteMD2021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb
Rollup plugins2021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
icestark2021-12-164862326a8de53d02f617e7b1986774fd7540fccd