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 a pnpm-workspace.yaml file in its root.
If you are looking into monorepo management, you might also want to look into 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. There's an article about bit install that talks about it: Painless Monorepo Dependency Management with Bit.
Protocole d'espace de travail (workspace:)
If linkWorkspacePackages is set to true, pnpm will link packages from the workspace if the available packages match the declared ranges. 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.
This protocol is especially useful when the linkWorkspacePackages option is set to 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:~, orworkspace:^) - 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:
For how to set up a repository using Rush, read this 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 :
Configuration
linkWorkspacePackages
- Par défaut: false
- Type: true, false, deep
If this is enabled, locally available packages are linked to node_modules instead of being downloaded from the registry. This is very convenient in a monorepo. If you need local packages to also be linked to subdependencies, you can use the deep setting.
Else, packages are downloaded and installed from the registry. However, workspace packages can still be linked by using the workspace: range protocol.
Packages are only linked if their versions satisfy the dependency ranges.
injectWorkspacePackages
- Par défaut: false
- Type: Boolean
Enables hard-linking of all local workspace dependencies instead of symlinking them. Alternatively, this can be achieved using dependenciesMeta[].injected, which allows to selectively enable hard-linking for specific dependencies.
Even if this setting is enabled, pnpm will prefer to deduplicate injected dependencies using symlinks—unless multiple dependency graphs are required due to mismatched peer dependencies. This behaviour is controlled by the dedupeInjectedDeps setting.
dedupeInjectedDeps
- Par défaut: true
- Type: Boolean
When this setting is enabled, dependencies that are injected will be symlinked from the workspace whenever possible. If the dependent project and the injected dependency reference the same peer dependencies, then it is not necessary to physically copy the injected dependency into the dependent's node_modules; a symlink is sufficient.
syncInjectedDepsAfterScripts
Added in: v10.5.0
- Default: undefined
- Type: String[]
Injected workspace dependencies are collections of hardlinks, which don't add or remove the files when their sources change. This causes problems in packages that need to be built (such as in TypeScript projects).
This setting is a list of script names. When any of these scripts are executed in a workspace package, the injected dependencies inside node_modules will also be synchronized.
preferWorkspacePackages
- Par défaut: false
- Type: Boolean
If this is enabled, local packages from the workspace are preferred over packages from the registry, even if there is a newer version of the package in the registry.
This setting is only useful if the workspace doesn't use saveWorkspaceProtocol.
sharedWorkspaceLockfile
- Par défaut: true
- Type: Boolean
If this is enabled, pnpm creates a single pnpm-lock.yaml file in the root of the workspace. This also means that all dependencies of workspace packages will be in a single node_modules (and get symlinked to their package node_modules folder for Node's module resolution).
Advantages of this option:
- every dependency is a singleton
- faster installations in a monorepo
- fewer changes in code reviews as they are all in one file
Even though all the dependencies will be hard linked into the root node_modules, packages will have access only to those dependencies that are declared in their package.json, so pnpm's strictness is preserved. This is a result of the aforementioned symbolic linking.
saveWorkspaceProtocol
- Default: rolling
- Type: true, false, rolling
This setting controls how dependencies that are linked from the workspace are added to package.json.
If foo@1.0.0 is in the workspace and you run pnpm add foo in another project of the workspace, below is how foo will be added to the dependencies field. The savePrefix setting also influences how the spec is created.
| saveWorkspaceProtocol | savePrefix | spec |
|---|---|---|
| false | '' | 1.0.0 |
| false | '~' | ~1.0.0 |
| false | '^' | ^1.0.0 |
| true | '' | workspace:1.0.0 |
| true | '~' | workspace:~1.0.0 |
| true | '^' | workspace:^1.0.0 |
| rolling | '' | workspace:* |
| rolling | '~' | workspace:~ |
| rolling | '^' | workspace:^ |
includeWorkspaceRoot
- Par défaut: false
- Type: Boolean
When executing commands recursively in a workspace, execute them on the root workspace project as well.
ignoreWorkspaceCycles
- Par défaut: false
- Type: Boolean
When set to true, no workspace cycle warnings will be printed.
disallowWorkspaceCycles
- Par défaut: false
- Type: Boolean
When set to true, installation will fail if the workspace has cycles.
failIfNoMatch
- Par défaut: false
- Type: Boolean
When set to true, the CLI will exit with a non-zero code if no packages match the provided filters.
For example, the following command will exit with a non-zero code because bad-pkg-name is not present in the workspace:
pnpm --filter=bad-pkg-name test