corepack とは
Node.js の実行環境には、パッケージマネージャーとして標準で npm コマンドが搭載されていますが、npm の代わりに yarn や pnpm などを導入しているプロジェクトが多くあります。
従来は、これらのコマンドを npm install -g pnpm のように別途インストールする必要がありましたが、Node.js に標準搭載された corepack の仕組みを使用すると、初めからインストールされているかのようにyarn や pnpm コマンドを実行できるようになります。
corepack が使用するパッケージマネージャーは、package.json の packageManager プロパティで宣言しておくことができるので、プロジェクト内で使用するパッケージマネージャーとそのバージョンを統一できます。
package.json の packageManager フィールドはプロジェクトが使うパッケージマネージャーとそのバージョンを宣言しているだけで、このフィールドは corepack 専用のフィールドというわけではありません。
あくまで、システムの Node.js 環境で corepack が有効化されている場合に、このフィールドの内容に基づいて yarn や pnpm のバージョンが自動制御される、ということです。最初の準備(既存の yarn/pnpm の削除と corepack の有効化)
もし、npm install や brew でグローバルインストールした yarn や pnpm がある場合は、もう必要ないのでアンインストールしておきましょう。
$ npm uninstall -g yarn
$ npm uninstall -g pnpm
$ brew uninstall yarn
$ brew uninstall pnpm
corepack コマンドは Node.js 環境に組み込まれていますが、Node.js 21 の時点ではまだ実験段階 (experimental status) のため、corepack enable コマンドを実行して明示的に有効化 (Opt-in) しておく必要があります。
このコマンドは、システム内で一度だけ実行すれば大丈夫です。
$ corepack enable
このコマンドを実行することで、node コマンドの実行ファイルが置かれたディレクトリ内に、yarn や pnpm などのシンボリックリンクが生成されます。
これで、システム全体で yarn や pnpm コマンドを実行できるようになります。
各パッケージマネージャーのコマンド(シンボリックリンク)が、node と同じ場所に存在していれば、おそらくうまくいっています。
$ which node npm yarn pnpm
/Users/maku/.nvm/versions/node/v21.6.1/bin/node
/Users/maku/.nvm/versions/node/v21.6.1/bin/npm
/Users/maku/.nvm/versions/node/v21.6.1/bin/yarn
/Users/maku/.nvm/versions/node/v21.6.1/bin/pnpm
ここで表示されるパス内の v21.6.1 という部分は、yarn、pnpm コマンドのバージョンとは関係ないことに注意してください。
プロジェクト内で使用する yarn や pnpm のバージョンを指定する
corepack 経由の yarn や pnpm を使用する場合、package.json ファイルの packageManager プロパティで、使用するパッケージマネージャーとそのバージョンを定義しておくことができます。
ここでは、テスト用の Node.js プロジェクトを作って設定してみます。
$ mkdir myapp && cd myapp
$ npm init -y
プロジェクト内で使用するパッケージマネージャーは、corepack use コマンドで指定します。
$ corepack use npm@* # npm の最新版を使う場合
$ corepack use npm@10 # npm バージョン 10.x.x を使う場合
$ corepack use yarn@* # yarn の最新版を使う場合
$ corepack use yarn@4 # yarn バージョン 4.x.x を使う場合
$ corepack use pnpm@* # pnpm の最新版を使う場合
$ corepack use pnpm@9 # pnpm バージョン 9.x.x を使う場合
例えば、パッケージマネージャーとして pnpm を使うよう指定した場合、package.json ファイルに次のように記録されます。
{
"name": "myapp",
"version": "1.0.0",
// ...
"packageManager": "pnpm@9.0.0+sha512.b4106707c7225b174...(省略)..."
}カレントディレクトリに package.json が存在しない状態で corepack use pnpm@9 を実行すると、以下のような packageManager フィールドのみが存在するファイルが自動生成されます。
{
"packageManager": "pnpm@9.0.0+..."
}この状態で、pnpm コマンドを実行すると、指定したバージョンの pnpm が起動するはずです。
$ pnpm --version
9.0.0
あとは、通常通り yarn や pnpm コマンドを使ってパッケージ管理していけば OK です。
$ pnpm add dotenv
使用する pnpm のバージョンは package.json に記述されているので、チーム内の他のメンバーが pnpm コマンドを実行するときも同じバージョンが使われるようになります。
$ corepack enable # (システム内で一度だけ実行)
$ pnpm install # 指定された pnpm バージョンを使って依存パッケージをインストール
$ pnpm build # build スクリプトの実行
プロジェクト内で使用する pnpm のバージョンを更新したいときは、新しいバージョンを corepack use で指定すれば OK です(package.json の packageManager の項目が更新されます)。
$ corepack use pnpm@10
# 下記でも package.json を更新してくれるけどハッシュコードが付かないっぽい
$ pnpm self-update