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.
A workspace must have apnpm-workspace.yaml file in itsroot.
If you are looking into monorepo management, you might also want to look intoBit.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. There's an article aboutbit install that talks about it:Painless Monorepo Dependency Management with Bit.
Protocole d'espace de travail (workspace:)
IflinkWorkspacePackages is set totrue, pnpm will link packages from the workspace if the available packagesmatch the declared ranges. For instance,foo@1.0.0 is linked intobar ifbar has"foo": "^1.0.0" in its dependencies andfoo@1.0.0 is in the workspace. However, ifbar has"foo": "2.0.0" in dependencies andfoo@2.0.0 is not in the workspace,foo@2.0.0 will be installed from the registry. Ce comportement introduit une certaine incertitude.
Luckily, pnpm supports theworkspace: protocol. Lorsque ce protocole est utilisé, pnpm refuse de résoudre autre chose qu’un package de l'espace de travail local. So, if you set"foo": "workspace:2.0.0", this timeinstallation will fail because"foo@2.0.0" isn't present in the workspace.
This protocol is especially useful when thelinkWorkspacePackages option isset tofalse. In that case, pnpm will only link packages from the workspace iftheworkspace: protocol is used.
Référencement des packages de l'espace de travail via des alias
Let's say you have a package in the workspace namedfoo. Usually, you wouldreference it as"foo": "workspace:*".
If you want to use a different alias, the following syntax will work too:"bar": "workspace:foo@*".
Avant la publication, les alias sont convertis en dépendances alliacées standards. The aboveexample will become:"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 havefoo in its dependencies declared as"foo": "workspace:../foo". Before publishing, these specs are converted toregular version specs supported by all package managers.
Publishing workspace packages
When a workspace package is packed into an archive (whether it's throughpnpm pack or one of the publish commands likepnpm publish), we dynamicallyreplace anyworkspace: dependency by:
- The corresponding version in the target workspace (if you use
workspace:*,workspace:~, orworkspace:^) - The associated semver range (for any other range type)
So for example, if we havefoo,bar,qar,zoo in the workspace and they all are at version1.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 stillbeing able to publish the resulting packages to the remote registry withoutneeding intermediary publish steps - your consumers will be able to use yourpublished workspaces as any other package, still benefitting from the guaranteessemver offers.
Release workflow
Versioning packages inside a workspace is a complex task and pnpm currently doesnot provide a built-in solution for it. However, there are 2 well tested toolsthat handle versioning and support pnpm:
For how to set up a repository using Rush, readthis page.
For using Changesets with pnpm, readthis guide.
Résolution de problèmes
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.
If you see the messageThere are cyclic workspace dependencies, please inspect workspace dependencies declared independencies,optionalDependencies anddevDependencies.
Exemples d'utilisation
Voici quelques-uns des projets open source les plus populaires qui utilisent la fonction d'espace de travail de pnpm :