Espacio de trabajo
pnpm tiene soporte incorporado para monorepos (también conocidos como repositorios de paquetes múltiples,repositorios de proyectos múltiples o repositorios monolíticos). Puede crear un espacio de trabajo para unir varios proyectos dentro de un único repositorio.
A workspace must have apnpm-workspace.yaml file in itsroot. A workspace also may have an.npmrc in its root.
If you are looking into monorepo management, you might also want to look intoBit.Bit usa pnpm en su interior, pero automatiza muchas de las cosas que actualmente se hacen manualmente en un espacio de trabajo tradicional administrado por pnpm/npm/Yarn. There's an article aboutbit install that talks about it:Painless Monorepo Dependency Management with Bit.
Protocolo de espacio de trabajo (workspace:)
Iflink-workspace-packages 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. Este comportamiento presenta algo de incertidumbre.
Luckily, pnpm supports theworkspace: protocol. Cuando se usa este protocolo, pnpm se negará a resolver cualquier cosa que no sea un paquete de espacio de trabajo 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 thelink-workspace-packages option isset tofalse. In that case, pnpm will only link packages from the workspace iftheworkspace: protocol is used.
Referenciando paquetes de espacio de trabajo a través de 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@*".
Antes de publicar, los alias se convierten en dependencias con alias regulares. The aboveexample will become:"bar": "npm:foo@1.0.0".
Referenciando paquetes de espacio de trabajo a través de su ruta relativa
En un espacio de trabajo con 2 paquetes:
+ packages
+ foo
+ bar
bar may havefoo in its dependencies declared as"foo": "workspace:../foo". Antes de publicar, estas especificaciones se convierten a las especificaciones de versión regular soportadas por todos los gestores de paquetes.
Publicando paquetes del espacio de trabajo
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:^) - El rango de versión semántica asociado (para cualquier otro tipo de rango)
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"
}
}
Será transformado en:
{
"dependencies":{
"foo":"1.5.0",
"bar":"~1.5.0",
"qar":"^1.5.0",
"zoo":"^1.5.0"
}
}
Esta característica le permite depender de sus paquetes espacios de trabajo locales mientras aún puede publicar los paquetes resultantes en el registro remoto sin necesidad de pasos intermedios de publicación. Sus consumidores podrán utilizar sus espacios de trabajo publicados como cualquier otro paquete, beneficiándose de las garantías que ofrece el versionado semántico.
Flujo de trabajo de lanzamiento
Versionar paquetes dentro de un espacio de trabajo es una tarea compleja y pnpm actualmente no proporciona una solución integrada para ello. Sin embargo, existen 2 herramientas bien probadas que manejan el control de versiones y admiten pnpm:
For how to set up a repository using Rush, readthis page.
For using Changesets with pnpm, readthis guide.
Resolución de problemas
pnpm no puede garantizar que los scripts se ejecuten en orden topológico si existen ciclos entre las dependencias del espacio de trabajo. Si pnpm detecta dependencias cíclicas durante la instalación, generará una advertencia. Si pnpm puede averiguar qué dependencias están causando los ciclos, también las mostrará.
If you see the messageThere are cyclic workspace dependencies, please inspect workspace dependencies declared independencies,optionalDependencies anddevDependencies.
Ejemplos de uso
Estos son algunos de los proyectos de código abierto más populares que utilizan la función de espacio de trabajo de pnpm: