Workspace

pnpm has built-in support for monorepositories (AKA multi-package repositories, multi-project repositories, or monolithic repositories). You can create a workspace to unite multiple projects inside a single repository.

A workspace must have a pnpm-workspace.yaml file in its root. A workspace also may have an .npmrc in its root.

Workspace - 图1tip

If you are looking into monorepo management, you might also want to look into Bit. Bit uses pnpm under the hood but automates a lot of the things that are currently done manually in a traditional workspace managed by pnpm/npm/Yarn. There’s an article about bit install that talks about it: Painless Monorepo Dependency Management with Bit.

Workspace protocol (workspace:)

By default, pnpm will link packages from the workspace if the available packages match the declared ranges. For instance, foo@1.0.0 is linked into bar if bar has "foo": "^1.0.0" in its dependencies and foo@1.0.0 is in the workspace. However, if bar has "foo": "2.0.0" in dependencies and foo@2.0.0 is not in the workspace, foo@2.0.0 will be installed from the registry. This behavior introduces some uncertainty.

Luckily, pnpm supports the workspace: protocol. When this protocol is used, pnpm will refuse to resolve to anything other than a local workspace package. So, if you set "foo": "workspace:2.0.0", this time installation will fail because "foo@2.0.0" isn’t present in the workspace.

This protocol is especially useful when the link-workspace-packages option is set to false. In that case, pnpm will only link packages from the workspace if the workspace: protocol is used.

Referencing workspace packages through aliases

Let’s say you have a package in the workspace named foo. Usually, you would reference it as "foo": "workspace:*".

If you want to use a different alias, the following syntax will work too: "bar": "workspace:foo@*".

Before publish, aliases are converted to regular aliased dependencies. The above example will become: "bar": "npm:foo@1.0.0".

Referencing workspace packages through their relative path

In a workspace with 2 packages:

  1. + packages
  2.     + foo
  3.     + 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:

  1. {
  2.     "dependencies": {
  3.         "foo": "workspace:*",
  4.         "bar": "workspace:~",
  5.         "qar": "workspace:^",
  6.         "zoo": "workspace:^1.5.0"
  7.     }
  8. }

Will be transformed into:

  1. {
  2.     "dependencies": {
  3.         "foo": "1.5.0",
  4.         "bar": "~1.5.0",
  5.         "qar": "^1.5.0",
  6.         "zoo": "^1.5.0"
  7.     }
  8. }

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.

Troubleshooting

pnpm cannot guarantee that scripts will be run in topological order if there are cycles between workspace dependencies. If pnpm detects cyclic dependencies during installation, it will produce a warning. If pnpm is able to find out which dependencies are causing the cycles, it will display them too.

If you see the message There are cyclic workspace dependencies, please inspect workspace dependencies declared in dependencies, optionalDependencies and devDependencies.

Usage examples

Here are a few of the most popular open source projects that use the workspace feature of pnpm:

ProjectStarsMigration dateMigration commit
Next.jsWorkspace - 图22022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
ViteWorkspace - 图32021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Vue 3.0Workspace - 图42021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
PrismaWorkspace - 图52021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
SlidevWorkspace - 图62021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
AstroWorkspace - 图72022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
TurborepoWorkspace - 图82022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Element PlusWorkspace - 图92021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
VerdaccioWorkspace - 图102021-09-219dbf73e955fcb70b0a623c5ab89649b95146c744
NextAuth.jsWorkspace - 图112022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
VueUseWorkspace - 图122021-09-25826351ba1d9c514e34426c85f3d69fb9875c7dd9
SvelteKitWorkspace - 图132021-09-26b164420ab26fa04fd0fbe0ac05431f36a89ef193
Cycle.jsWorkspace - 图142021-09-21f2187ab6688368edb904b649bd371a658f6a8637
VercelWorkspace - 图152023-01-129c768b98b71cfc72e8638bf5172be88c39e8fa69
VitestWorkspace - 图162021-12-13d6ff0ccb819716713f5eab5c046861f4d8e4f988
MilkdownWorkspace - 图172021-09-264b2e1dd6125bc2198fd1b851c4f00eda70e9b913
NhostWorkspace - 图182022-02-0710a1799a1fef2f558f737de3bb6cadda2b50e58f
LogtoWorkspace - 图192021-07-290b002e07850c8e6d09b35d22fab56d3e99d77043
ByteMDWorkspace - 图202021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb
Rollup pluginsWorkspace - 图212021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
icestarkWorkspace - 图222021-12-164862326a8de53d02f617e7b1986774fd7540fccd