Skip to main content
Version: 5.x

Workspace

A pnpm beépített támogatást nyújt monorepókhoz (más néven többcsomagos repozitóriumok, többprojektes repozitóriumok vagy monolit repozitóriumok). Létrehozhatsz egy workspace-t, amely több projektet egyesít egyetlen repozitóriumon belül.

A workspace gyökerében egy pnpm-workspace.yaml fájl kell hogy jelen legyen. A workspace gyökerében egy .npmrc fájl is jelen lehet.

Workspace protokoll (workspace:)

Supported since v3.7.0.

Alap konfiguráció szerint pnpm a workspacen belülről linkeli a csomagokat, ha a rendelkezésre álló lokális csomagok megfelelnek a deklarált verzióval. Például a foo@1.0.0 a barhoz lesz linkelve ha a bar függőségei közt van a "foo": "^1.0.0". Ha azonban bar függősége "foo": "2.0.0", és foo@2.0.0 nincs a workspaceben, akkor foo@2.0.0 a registry-ből lesz letöltve. Ez a viselkedés némi bizonytalanságot okozhat.

Luckily, pnpm supports the workspace: protocol (the same as in Yarn v2). Ha ez a protokoll van használva, pnpm csak a workspace-ben jelenlévő csomagokat fogja felhasználni a függőség telepítésére. Tehát, ha a függőség a következő "foo": "workspace:2.0.0", a telepítés sikertelen lesz, mert a "foo@2.0.0" nincs jelen a workspace-ben.

Ez a protokoll különösen akkor válik hasznossá, ha a link-workspace-packages beállítás false<code>-ra van beállítva. Ebben az esetben pnpm csak akkor linkel a workspace-en belül csomagokat, ha a <code>workspace: protokoll van használva az adott csomag deklarálására.

Workspace csomagra való hivatkozás álnév használatával

Added in 5.12.0

Tegyük fel, hogy van egy foo nevű csomag a workspace-ben. Általában úgy hivatkoznál rá hogy "foo": "workspace:*".

Ha más nevet szeretnél használni a függőség számára, akkor a következő szintaxis is működni fog: "bar": "workspace:foo@*".

Publish előtt az ilyen álnévvel telepített workspace függőségek átalakulnak szokványos álneves függőségekbe. A fenti példa a következő lesz: "bar": "npm:foo@1.0.0".

Workspace csomagra való hivatkozás relatív útvonallal

Added in 5.12.0

Két csomaggal rendelkező workace-ben:

+ packages
+ foo
+ bar

bar függőségeiben ott lehet foo mint "foo": "workspace:../foo". Publish előtt ez a specifikáció normál verzió specifikációvá van cserélve, amelyet minden csomagkezelő ismer.

Workspace csomagok publisholása

Amikor egy workspace csomag archívumba van csomagolva (akár pnpm pack vagy az egyik publish parancs használata által, például pnpm publish), dinamikusan le lesznek cserélve a workspace: protokoll specifikációk:

  • The corresponding version in the target workspace (if you use *)
  • A megadott semver specifikációra (bármely más specifikáció esetében)

So for example, if we have a workspace package at version 1.5.0, the following:

{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:^1.2.3"
}
}

Átalakulnak ezekre:

{
"dependencies": {
"foo": "1.5.0",
"bar": "^1.2.3"
}
}

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.

Options

Added in: v2.14.0

  • Default: true
  • 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 (since v5).

Else, packages are downloaded and installed from the registry. However, workspace packages can still be linked by using the workspace: range protocol.

prefer-workspace-packages

Added in: v5.13.0

  • Default: 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 save-workspace-protocol.

shared-workspace-lockfile

Added in: v2.17.0 as shared-workspace-shrinkwrap

  • Default: 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
note

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.

save-workspace-protocol

  • Default: true
  • Type: Boolean

If this is enabled, new dependencies will be added with the workspace protocol IF (and only if) they are present in the workspace.

You might want to change this setting to false if the tooling in your repository does not understand the workspace protocol (and ideally submit a PR to your tooling to get it added in the future).