Skip to main content
Version: 5.x

ワークスペース

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

ワークスペースを作成するには、ルートに pnpm-workspace.yaml を作成します。 また、ワークスペースではルートに .npmrc を置くこともできます。

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

Supported since v3.7.0.

デフォルトでは、使用可能なパッケージが宣言された範囲と一致する場合、 pnpm はワークスペースからパッケージをリンクします。 たとえば、 foo@1.0.0 は、 "foo": "^1.0.0" を依存として定義している bar プロジェクトにリンクされます。 ただし、 bar が依存として "foo": "2.0.0" を定義しても、foo@2.0.0 がワークスペース側になければ、foo@2.0.0 はレジストリからインストールされます。 この動作はいくつかの不確実性をもたらします。

Luckily, pnpm supports the workspace: protocol (the same as in Yarn v2). このプロトコルが使用されている場合、 pnpm は ローカルにあるワークスペースパッケージ以外のものに解決されることを禁止します。 そのため、 "foo": "workspace:2.0.0"を設定すると、今回は "foo@2.0.0" がワークスペースに存在しないため、インストールに失敗します。

このプロトコルは、 link-workspace-packages オプションが false に設定されている場合に特に便利です。 この場合、 workspace: プロトコルが使用されている場合にのみ、pnpm はワークスペースからパッケージをリンクします。

エイリアスを介したワークスペースパッケージの参照

Added in 5.12.0

たとえば、 foo という名前のパッケージがワークスペースにあるとします。 通常、 "foo": "workspace:*" として参照します。

別のエイリアスを使用する場合は、次の構文も使用できます: "bar": "workspace:foo@*".

公開する前に、エイリアスは通常のエイリアスされた依存関係に変換されます。 上記の例は "bar": "npm:foo@1.0.0" になります。

相対パスでワークスペースのパッケージを参照する

Added in 5.12.0

ワークスペースに 2 つのパッケージがあるとします:

+ packages
+ foo
+ bar

barfoo を依存として "foo": "workspace:../foo" と宣言することができます。 公開する前に、これらのバージョン指定はすべてのパッケージマネージャーがサポートしている通常のバージョン指定に変換されます。

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

ワークスペースのパッケージが (pnpm packpnpm publish などのコマンドを使用して) アーカイブファイルにパックされる際に、 workspace: プロトコルで書かれた依存関係を次のように変換します。

  • The corresponding version in the target workspace (if you use *)
  • 対応する semver の範囲指定 (その他の範囲指定を使っている場合)

So for example, if we have a workspace package at version 1.5.0, the following:

{
"dependencies": {
"foo": "workspace:*",
"bar": "workspace:^1.2.3"
}
}

これは以下のように変換されます。

{
"dependencies": {
"foo": "1.5.0",
"bar": "^1.2.3"
}
}

この機能により、ローカルにあるワークスペースのパッケージに依存する指定を使用しながら、最終的にパッケージをレジストリに公開する際に追加の変換ステップを挟む必要がなくなります。あなたのパッケージの使用者は、公開されたパッケージを他のパッケージとなんら変わらないように使うことができ、semver の指定による保証を受け続けることができます。

リリースワークフロー

ワークスペース内のパッケージのバージョニングは複雑なタスクであり、現時点では pnpm は組み込みの解決方法を提供していません。 しかし、次の 2 つは、バージョニングを扱う pnpm をサポートした、よくテストされたツールです。

Rush を使用してレポジトリをセットアップする方法については、こちらのページ (英語) を参照してください。

Changeset を pnpm と組み合わせて使用する方法については、こちらのガイド を参照してください。

Options

Added in: v2.14.0

  • デフォルト: true
  • タイプ: true, false, deep

このオプションを有効にすると、ローカルで利用可能なパッケージはレジストリからダウンロードせずに node_modules へとリンクされます。 これはモノレポで非常に役立ちます。 間接的な依存関係にもローカルのパッケージをリンクする場合は、deep を指定することができます。 (v5以降)

それ以外の場合には、依存はレジストリからダウンロードされます。 ただし、ワークスペースのパッケージは workspace: プロトコルを範囲指定することでリンクすることができます。

prefer-workspace-packages

追加されたバージョン:v5.13.0

  • デフォルト: false
  • タイプ: Boolean

このオプションを有効にすると、レジストリに新しいバージョンのパッケージがある場合でも、ワークスペース内のローカルにあるパッケージが優先されます。

この設定は、ワークスペースのオプションで save-workspace-protocol が使用されていない場合にのみ役立ちます。

shared-workspace-lockfile

追加されたバージョン:v2.17.0 で shared-workspace-shrinkwrap として追加

  • デフォルト: true
  • タイプ: Boolean

このオプションが有効になっている場合、pnpm はワークスペースのルートの pnpm-lock.yaml のみを作成します。 これにより、すべてのワークスペースの依存がワークスペースのルートの node_modules この一箇所に集められます。(そして各パッケージの node_modules ディレクトリへとシンボリックリンクが作成されます。)

このオプションの利点:

  • 各依存の一箇所への設置
  • より高速なモノレポでのインストール
  • 一箇所にすべて記述され、より少ないコードレビュー時の変更
note

たとえルートの node_modules にすべての依存がハードリンクされていても、各ワークスペースパッケージはその package.json に定義された依存にしかアクセスできません。これにより、 pnpm の厳密性は保持されます。 これは前述のシンボリックリンクによるものです。

save-workspace-protocol

  • デフォルト: true
  • タイプ: Boolean

このオプションを有効にすると、新しい依存はワークスペースに存在している場合にのみ追加されます。

リポジトリで使用しているツールがワークスペースプロトコルを解釈できない場合にこのオプションを false にします。(また、将来的にワークスペースプロトコルに対応できるように、そのツールに PR を送ることも理想的です。)