メインコンテンツにスキップ
バージョン: 9.x

ワークスペース

pnpmには、モノレポジトリ（別名：マルチパッケージリポジトリ、マルチプロジェクトリポジトリ、モノリシックリポジトリ）のサポートが組み込まれています。ワークスペースを作成して、単一のリポジトリ内に複数のプロジェクトを統合できます。

ワークスペースには、ルートにpnpm-workspace.yamlファイルが必要です。ワークスペースのルートには、.npmrcファイルがある場合もあります。

ヒント

モノレポジトリの管理について調べている場合は、Bitについても調べてみることをお勧めします。Bitは内部でpnpmを使用していますが、pnpm/npm/Yarnで管理される従来のワークスペースで手動で行われている多くのことを自動化します。bit installに関する記事があり、それについて説明しています：Bitによる苦痛のないモノレポジトリの依存関係管理。

ワークスペースプロトコル (workspace:)​

デフォルトでは、pnpmは、利用可能なパッケージが宣言された範囲と一致する場合、ワークスペースからパッケージをリンクします。たとえば、barの依存関係に"foo": "^1.0.0"があり、foo@1.0.0がワークスペースにある場合、foo@1.0.0はbarにリンクされます。ただし、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": "workspace:../foo"として宣言されているfooを持つことができます。公開前に、これらの仕様は、すべてのパッケージマネージャーでサポートされている通常のバージョン仕様に変換されます。

ワークスペースパッケージの公開​

ワークスペースパッケージがアーカイブにパックされる（pnpm packを使用する場合でも、pnpm publishなどの公開コマンドを使用する場合でも）と、workspace:依存関係は、動的に

  • ターゲットワークスペース内の対応するバージョンに置き換えられます（workspace:*、workspace:~、またはworkspace:^を使用する場合）。
  • 関連付けられたセマンティックバージョンの範囲（他の範囲タイプの場合）。

したがって、たとえば、ワークスペースに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は現在、それに対する組み込みのソリューションを提供していません。ただし、バージョン管理を処理し、pnpmをサポートする2つの十分にテストされたツールがあります。

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