Воркспейсы
pnpm имеет встроенную поддержку монорепозиториев (multi-package репозиториев, multi-project репозиториев или монолитных репозиториев). Можно создать рабочую область для объединения нескольких проектов в одном репозитории.
Рабочая область должна иметь файл pnpm-workspace.yaml в корневом каталоге. Рабочая область также может иметь .npmrc в корне.
Если вы изучаете управление монорепозиторием, вы также можете заглянуть в Bit. Bit использует pnpm под капотом, но автоматизирует многие вещи, которые в настоящее время выполняются вручную в традиционной рабочей области, управляемой pnpm/npm/Yarn. Есть статья о bit установке, в которой говорится об этом: Безболезненное управление зависимостями монорепозитория с Bit.
Протокол рабочей области (workspace:)
По умолчанию pnpm будет связывать пакеты из рабочей области, если доступные пакеты соответствуют объявленным диапазонам. 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. Однако, если bar имеет "foo": "2.0.0" в зависимостях и foo@2.0.0 не находится в рабочей области, foo@2.0.0 будет установлен из реестра. Такое поведение вносит некоторую неопределенность.
К счастью, pnpm поддерживает протокол workspace:. Когда используется этот протокол, pnpm откажется разрешать что-либо, кроме пакета локальной рабочей области. Итак, если вы установите "foo": "workspace:2.0.0", на этот раз установка завершится ошибкой, поскольку "foo@2.0.0" отсутствует в рабочей области.
Этот протокол особенно полезен, когда для параметра link-workspace-packages установлено значение false. В этом случае pnpm будет связывать пакеты из рабочей области только, если используется протокол workspace:.
Ссылки на пакеты рабочей области через псевдонимы
Допустим, у вас есть пакет в рабочей области с именем foo. Обычно вы бы сослались на него как "foo": "workspace:*".
Если вы хотите использовать другой псевдоним, следующий синтаксис также будет работать: "bar": "workspace:foo@*".
Перед публикацией псевдонимы конвертируются в обычные алиасные зависимости. Приведенный выше пример станет следующим: "bar": "npm:foo@1.0.0".
Ссылка на пакеты рабочей области через их относительный путь
В рабочей области с 2 пакетами:
+ packages
+ foo
+ bar
bar может иметь foo в своих зависимостях, объявленных как "foo": "workspace:../foo". Перед публикацией эти спецификации преобразуются в спецификации обычных версии, поддерживаемые всеми менеджерами пакетов.
Публикация пакетов рабочей области
Когда пакет рабочей области упакован в архив (будь то через pnpm pack или одну из команд публикации, например pnpm publish), мы динамически заменяем любую зависимость workspace: на:
- Соответствующую версию в целевой рабочей области (если вы используете
workspace:*,workspace:~илиworkspace: ^) - Связанный диапазон semver (для любого другого типа диапазона)
Так, например, если у нас есть foo, bar, qar, zoo в рабочей области, и все они имеют версию 1.5.0, то:
{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:~",
"qar": "workspace:^",
"zoo": "workspace:^1.5.0"
}
}
Будет преобразован в:
{
"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.
Решение проблем
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.
Примеры использования
Вот несколько наиболее популярных проектов с открытым исходным кодом, которые используют функцию рабочего пространства pnpm:
| Проект | Звезды | Дата миграции | Коммит миграции |
|---|---|---|---|
| Next.js |  | 2022-05-29 | f7b81316aea4fc9962e5e54981a6d559004231aa |
| Vite |  | 2021-09-26 | 3e1cce01d01493d33e50966d0d0fd39a86d229f9 |
| Nuxt |  | 2022-10-17 | 74a90c566c936164018c086030c7de65b26a5cb6 |
| Vue 3.0 |  | 2021-10-09 | 61c5fbd3e35152f5f32e95bf04d3ee083414cecb |
| Prisma |  | 2021-09-21 | c4c83e788aa16d61bae7a6d00adc8a58b3789a06 |
| Slidev |  | 2021-04-12 | d6783323eb1ab1fc612577eb63579c8f7bc99c3a |
| Astro |  | 2022-03-08 | 240d88aefe66c7d73b9c713c5da42ae789c011ce |
| Turborepo |  | 2022-03-02 | fd171519ec02a69c9afafc1bc5d9d1b481fba721 |
| Element Plus |  | 2021-09-23 | f9e192535ff74d1443f1d9e0c5394fad10428629 |
| Verdaccio |  | 2021-09-21 | 9dbf73e955fcb70b0a623c5ab89649b95146c744 |
| NextAuth.js |  | 2022-05-03 | 4f29d39521451e859dbdb83179756b372e3dd7aa |
| VueUse |  | 2021-09-25 | 826351ba1d9c514e34426c85f3d69fb9875c7dd9 |
| SvelteKit |  | 2021-09-26 | b164420ab26fa04fd0fbe0ac05431f36a89ef193 |
| Cycle.js |  | 2021-09-21 | f2187ab6688368edb904b649bd371a658f6a8637 |
| Vercel |  | 2023-01-12 | 9c768b98b71cfc72e8638bf5172be88c39e8fa69 |
| Vitest |  | 2021-12-13 | d6ff0ccb819716713f5eab5c046861f4d8e4f988 |
| Milkdown |  | 2021-09-26 | 4b2e1dd6125bc2198fd1b851c4f00eda70e9b913 |
| Nhost |  | 2022-02-07 | 10a1799a1fef2f558f737de3bb6cadda2b50e58f |
| Logto |  | 2021-07-29 | 0b002e07850c8e6d09b35d22fab56d3e99d77043 |
| ByteMD |  | 2021-02-18 | 36ef25f1ea1cd0b08752df5f8c832302017bb7fb |
| Rollup plugins |  | 2021-09-21 | 53fb18c0c2852598200c547a0b1d745d15b5b487 |
| icestark |  | 2021-12-16 | 4862326a8de53d02f617e7b1986774fd7540fccd |