Воркспейсы
pnpm имеет встроенную поддержку монорепозиториев (multi-package репозиториев, multi-project репозиториев или монолитных репозиториев). Можно создать рабочую область для объединения нескольких проектов в одном репозитории.
Рабочая область должна иметь файл pnpm-workspace.yaml в корневом каталоге. Рабочая область также может иметь .npmrc в корне.
Если вы изучаете управление монорепозиторием, вы также можете заглянуть в Bit. Bit использует pnpm под капотом, но автоматизирует многие вещи, которые в настоящее время выполняются вручную в традиционной рабочей области, управляемой pnpm/npm/Yarn. There's an article about bit install that talks about it: Painless Monorepo Dependency Management with Bit.
Протокол рабочей области (workspace:)
If link-workspace-packages is set to true, pnpm will link packages from the workspace if the available packages match the declared ranges. Например, 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:
