Перейти к основному содержимому
Версия: Будущая

Воркспейсы

pnpm имеет встроенную поддержку монорепозиториев (multi-package репозиториев, multi-project репозиториев или монолитных репозиториев). Можно создать рабочую область для объединения нескольких проектов в одном репозитории.

Рабочая область должна иметь файл pnpm-workspace.yaml в корневом каталоге. Рабочая область также может иметь .npmrc в корне.

совет

Если вы изучаете управление монорепозиторием, вы также можете заглянуть в Bit. Bit использует pnpm под капотом, но автоматизирует многие вещи, которые в настоящее время выполняются вручную в традиционной рабочей области, управляемой pnpm/npm/Yarn. Есть статья о bit установке, в которой говорится об этом: Безболезненное управление зависимостями монорепозитория с Bit.

Протокол рабочей области (workspace:)​

По умолчанию pnpm будет связывать пакеты из рабочей области, если доступные пакеты соответствуют объявленным диапазонам. Например, foo@1.0.0 связывается с bar если bar имеет в своих зависимостях "foo": "^1.0.0" и foo@1.0.0 находится в рабочей области. Однако, если 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"
    }
}

Эта функция позволяет вам использовать локальные пакеты в рабочей области, при этом публиковать собранные пакеты в удаленном реестре без дополнительных промежуточных шагов - ваши потребители смогут использовать ваши опубликованные рабочие пространства как любой другой пакет, при этом сохраняя гарантии, которые предлагает семантическое версионирование.

Процесс выпуска пакетов​

Управление версиями пакетов внутри рабочей области — сложная задача, и pnpm в настоящее время не предоставляет для нее встроенного решения. Однако, есть 2 хорошо протестированных инструмента, которые позволяют управляют версионированием и поддерживают pnpm:

Чтобы настроить репозиторий с помощью Rush, читайте эту страницу.

Для использования Changesets с помощью pnpm, прочитайте это руководство.

Устранение неисправностей​

pnpm не может гарантировать, что скрипты будут запущены в топологическом порядке, если между зависимостями рабочей области есть циклы. Если pnpm обнаруживает циклические зависимости во время установки, будет выведено предупреждение. Если pnpm может выяснить, какие зависимости вызывают циклы, то они также будут отображены.

Если вы видите сообщение There are cyclic workspace dependencies, пожалуйста, проверьте зависимости рабочей области, объявленные в dependencies, optionalDependencies и devDependencies.

Примеры использования​

Вот несколько наиболее популярных проектов с открытым исходным кодом, которые используют функцию рабочего пространства pnpm:

ПроектЗвездыДата миграцииКоммит миграции
Next.js2022-05-29f7b81316aea4fc9962e5e54981a6d559004231aa
Material UI2024-01-03a1263e3e5ef8d840252b4857f85b33caa99f471d
Vite2021-09-263e1cce01d01493d33e50966d0d0fd39a86d229f9
Nuxt2022-10-1774a90c566c936164018c086030c7de65b26a5cb6
Vue 3.02021-10-0961c5fbd3e35152f5f32e95bf04d3ee083414cecb
Astro2022-03-08240d88aefe66c7d73b9c713c5da42ae789c011ce
n8n2022-11-09736777385c54d5b20174c9c1fda38bb31fbf14b4
Prisma2021-09-21c4c83e788aa16d61bae7a6d00adc8a58b3789a06
Slidev2021-04-12d6783323eb1ab1fc612577eb63579c8f7bc99c3a
Turborepo2022-03-02fd171519ec02a69c9afafc1bc5d9d1b481fba721
Ember.js2023-10-18b6b05da662497183434136fb0148e1dec544db04
Element Plus2021-09-23f9e192535ff74d1443f1d9e0c5394fad10428629
NextAuth.js2022-05-034f29d39521451e859dbdb83179756b372e3dd7aa
Qwik2022-11-14021b12f58cca657e0a008119bc711405513e1ee9
VueUse2021-09-25826351ba1d9c514e34426c85f3d69fb9875c7dd9
SvelteKit2021-09-26b164420ab26fa04fd0fbe0ac05431f36a89ef193
Verdaccio2021-09-219dbf73e955fcb70b0a623c5ab89649b95146c744
Vercel2023-01-129c768b98b71cfc72e8638bf5172be88c39e8fa69
Vitest2021-12-13d6ff0ccb819716713f5eab5c046861f4d8e4f988
Cycle.js2021-09-21f2187ab6688368edb904b649bd371a658f6a8637
Milkdown2021-09-264b2e1dd6125bc2198fd1b851c4f00eda70e9b913
Nhost2022-02-0710a1799a1fef2f558f737de3bb6cadda2b50e58f
Logto2021-07-290b002e07850c8e6d09b35d22fab56d3e99d77043
Rollup plugins2021-09-2153fb18c0c2852598200c547a0b1d745d15b5b487
icestark2021-12-164862326a8de53d02f617e7b1986774fd7540fccd
ByteMD2021-02-1836ef25f1ea1cd0b08752df5f8c832302017bb7fb