Робочий простір
pnpm має вбудовану підтримку монорепозиторіїв (також відомих як репозиторії з декількома пакунками, репозиторії з декількома проєктами або монолітні репозиторії). Ви можете створити робочий простір, щоб обʼєднати кілька проєктів в одному репозиторії.
A workspace must have apnpm-workspace.yaml file in itsroot. A workspace also may have an.npmrc in its root.
Якщо ви розглядаєте управління монорепозиторіями, ви також можете розглянутиBit.Bit використовує pnpm під капотом, але автоматизує багато речей, які зараз виконуються вручну в традиційному робочому просторі, керованому pnpm/npm/Yarn. There's an article aboutbit install that talks about it:Painless Monorepo Dependency Management with Bit.
Протокол робочого простору (workspace:)
Iflink-workspace-packages is set totrue, pnpm will link packages from the workspace if the available packagesmatch the declared ranges. For instance,foo@1.0.0 is linked intobar ifbar has"foo": "^1.0.0" in its dependencies andfoo@1.0.0 is in the workspace. However, ifbar has"foo": "2.0.0" in dependencies andfoo@2.0.0 is not in the workspace,foo@2.0.0 will be installed from the registry. Така поведінка вносить певну невизначеність.
Luckily, pnpm supports theworkspace: protocol. При використанні цього протоколу pnpm відмовлятиметься виконувати перетворення на будь-що, окрім пакунків локального робочого простору. So, if you set"foo": "workspace:2.0.0", this timeinstallation will fail because"foo@2.0.0" isn't present in the workspace.
This protocol is especially useful when thelink-workspace-packages option isset tofalse. In that case, pnpm will only link packages from the workspace iftheworkspace: protocol is used.
Посилання на пакунки робочого простору через псевдоніми
Let's say you have a package in the workspace namedfoo. Usually, you wouldreference it as"foo": "workspace:*".
If you want to use a different alias, the following syntax will work too:"bar": "workspace:foo@*".
Перед публікацією псевдоніми перетворюються на звичайні залежності від псевдонімів. The aboveexample will become:"bar": "npm:foo@1.0.0".
Посилання на пакунки робочого простору через їхній відносний шлях
У робочому просторі з 2 пакунками:
+ packages
+ foo
+ bar
bar may havefoo in its dependencies declared as"foo": "workspace:../foo". Перед публікацією ці специфікації перетворюються у звичайні специфікації версій, які підтримуються усіма менеджерами пакунків.
Публікація пакунків робочого простору
When a workspace package is packed into an archive (whether it's throughpnpm pack or one of the publish commands likepnpm publish), we dynamicallyreplace anyworkspace: dependency by:
- The corresponding version in the target workspace (if you use
workspace:*,workspace:~, orworkspace:^) - Асоційований діапазон Semver (для будь-якого іншого типу діапазону)
So for example, if we havefoo,bar,qar,zoo in the workspace and they all are at version1.5.0, the following:
{
"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"
}
}
Ця функція дозволяє вам покладатися на ваші локальні пакунки робочих просторів і водночас публікувати отримані пакунки у віддаленому реєстрі без проміжних кроків публікації — ваші користувачі зможуть використовувати ваші опубліковані робочі простори як будь-які інші пакунки, отримуючи вигоду від гарантій, що їх пропонує Semver.
Процес релізу
Керування версіями пакунків у робочому просторі є складним завданням, і наразі pnpm не надає вбудованого рішення для цього. Однак є 2 добре протестовані інструменти, які працюють з версіями і підтримують pnpm:
For how to set up a repository using Rush, readthis page.
For using Changesets with pnpm, readthis guide.
Усунення несправностей
pnpm не може гарантувати виконання скриптів у топологічному порядку, якщо між залежностями робочого простору є цикли. Якщо pnpm виявить циклічні залежності під час встановлення, він видасть попередження. Якщо pnpm зможе зʼясувати, які залежності спричиняють цикли, він також покаже їх.
If you see the messageThere are cyclic workspace dependencies, please inspect workspace dependencies declared independencies,optionalDependencies anddevDependencies.
Приклад використання
Ось декілька найпопулярніших відкритих проєктів, які використовують функцію робочого простору pnpm: