Workspace (ruang kerja)
pnpm memiliki dukungan bawaan untuk monorepositori (repositori multi paket, repositori multi proyek, atau repositori monolitik). Anda dapat membuat workspace untuk menyatukan beberapa proyek di dalam satu repositori.
Sebuah workspace haruslah memiliki pnpm-workspace.yaml di dalam folder akarnya. Sebuah workspace juga mungkin perlu memiliki .npmrc di dalam folder akarnya.
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.
Protokol workspace (workspace:)
Secara asali, pnpm akan menautkan paket dari workspace jika paket tersedia cocok dengan rentang yang dideklarasikan. 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. Namun, jika bar memiliki "foo": "2.0.0" dalam dependensi dan foo@2.0.0 tidak ada di workspace, maka foo@2.0.0 akan diinstal dari registri. Perilaku ini memperkenalkan beberapa ketidakpastian.
Untungnya, pnpm mendukung protokol workspace:. Ketika protokol ini digunakan, pnpm akan menolak untuk menyelesaikan apa pun selain paket workspace lokal. Jadi, jika Anda menyetel "foo": "workspace:2.0.0", kali ini instalasi akan gagal karena "foo@2.0.0" tidak ada di workspace.
This protocol is especially useful when the link-workspace-packages option is set to false. Dalam hal ini, pnpm hanya akan menautkan paket dari workspace jika protokol workspace: digunakan.
Merujuk paket workspace melalui alias
Katakanlah Anda memiliki paket di workspace bernama foo. Biasanya, Anda akan mereferensikannya sebagai "foo": "workspace:*".
Jika Anda ingin menggunakan alias yang berbeda, sintaks berikut juga akan berfungsi: "bar": "workspace:foo@*".
Sebelum dipublikasikan, alias dikonversi ke dependensi alias biasa. Contoh di atas akan menjadi: "bar": "npm:foo@1.0.0".
Merujuk paket workspace melalui jalur relatifnya
Di workspace dengan 2 paket:
+ packages
+ foo
+ bar
bar mungkin memiliki foo dalam dependensinya yang dinyatakan sebagai "foo": "workspace:../foo". Sebelum dipublikasikan, spesifikasi ini dikonversi ke spesifikasi versi reguler yang didukung oleh semua pengelola paket.
Memublikasikan paket workspace
Ketika paket workspace dikemas ke dalam sebuah arsip (baik itu melalui pnpm pack atau salah satu perintah terbitkan seperti pnpm publish), kami secara dinamis menggantikan setiap dependensi workspace: dengan:
- Versi yang sesuai di workspace target (jika Anda menggunakan
workspace:*,workspace:~, atauworkspace:^) - Rentang semver terkait (untuk jenis rentang lainnya)
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.
Alur kerja rilis
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.
Pemecahan Masalah
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:
| Project | Stars | Migration date | Migration commit |
|---|---|---|---|
| Next.js |  | 2022-05-29 | f7b81316aea4fc9962e5e54981a6d559004231aa |
| Material UI |  | 2024-01-03 | a1263e3e5ef8d840252b4857f85b33caa99f471d |
| Vite |  | 2021-09-26 | 3e1cce01d01493d33e50966d0d0fd39a86d229f9 |
| Nuxt |  | 2022-10-17 | 74a90c566c936164018c086030c7de65b26a5cb6 |
| Vue 3.0 |  | 2021-10-09 | 61c5fbd3e35152f5f32e95bf04d3ee083414cecb |
| Astro |  | 2022-03-08 | 240d88aefe66c7d73b9c713c5da42ae789c011ce |
| n8n |  | 2022-11-09 | 736777385c54d5b20174c9c1fda38bb31fbf14b4 |
| Prisma |  | 2021-09-21 | c4c83e788aa16d61bae7a6d00adc8a58b3789a06 |
| Slidev |  | 2021-04-12 | d6783323eb1ab1fc612577eb63579c8f7bc99c3a |
| Turborepo |  | 2022-03-02 | fd171519ec02a69c9afafc1bc5d9d1b481fba721 |
| Ember.js |  | 2023-10-18 | b6b05da662497183434136fb0148e1dec544db04 |
| Element Plus |  | 2021-09-23 | f9e192535ff74d1443f1d9e0c5394fad10428629 |
| NextAuth.js |  | 2022-05-03 | 4f29d39521451e859dbdb83179756b372e3dd7aa |
| Qwik |  | 2022-11-14 | 021b12f58cca657e0a008119bc711405513e1ee9 |
| VueUse |  | 2021-09-25 | 826351ba1d9c514e34426c85f3d69fb9875c7dd9 |
| SvelteKit |  | 2021-09-26 | b164420ab26fa04fd0fbe0ac05431f36a89ef193 |
| Verdaccio |  | 2021-09-21 | 9dbf73e955fcb70b0a623c5ab89649b95146c744 |
| Vercel |  | 2023-01-12 | 9c768b98b71cfc72e8638bf5172be88c39e8fa69 |
| Vitest |  | 2021-12-13 | d6ff0ccb819716713f5eab5c046861f4d8e4f988 |
| Cycle.js |  | 2021-09-21 | f2187ab6688368edb904b649bd371a658f6a8637 |
| Milkdown |  | 2021-09-26 | 4b2e1dd6125bc2198fd1b851c4f00eda70e9b913 |
| Nhost |  | 2022-02-07 | 10a1799a1fef2f558f737de3bb6cadda2b50e58f |
| Logto |  | 2021-07-29 | 0b002e07850c8e6d09b35d22fab56d3e99d77043 |
| Rollup plugins |  | 2021-09-21 | 53fb18c0c2852598200c547a0b1d745d15b5b487 |
| icestark |  | 2021-12-16 | 4862326a8de53d02f617e7b1986774fd7540fccd |
| ByteMD |  | 2021-02-18 | 36ef25f1ea1cd0b08752df5f8c832302017bb7fb |