🦁

pnpm の特徴

2022/07/25に公開

JavaScript

Node.js

pnpm

tech

pnpm は npm、yarn と並ぶ JavaScript のパッケージマネージャーです。pnpm と言う名前は「performant npm」に由来します。

https://pnpm.io/ja/

npm と互換性を持ち、以下のような特徴があります。

他のツールと比較して最大 2 倍高速
ディスク容量を効率化
厳格なパッケージ管理で、package.json に記載のあるものにしかアクセスできない

pnpm を始める

pnpm は以下のコマンドからインストールできます。

# macOS or Linux
$ curl -fsSL https://get.pnpm.io/install.sh | sh -
# Windows (PowerShell) 
$ iwr https://get.pnpm.io/install.ps1 -useb | iex

または、npm を使用してインストールできます。

$ npm install -g pnpm

pnpm のインストールが完了したら、試しに express をインストールしてみましょう。パッケージをインストールするには pnpm install <パッケージ名> コマンドを実行します。

$ pnpm install express
Packages: +57
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Packages are hard linked from the content-addressable store to the virtual store.
  Content-addressable store is at: ~/Library/pnpm/store/v3
  Virtual store is at:             node_modules/.pnpm
Progress: resolved 61, reused 0, downloaded 57, added 57, done

dependencies:
+ express 4.18.1

ディスク容量が節約された node_modules

「Packages are hard linked from the content-addressable store to the virtual store.」と表示されているとおり、パッケージの実態ファイルはすべてグローバルに管理される Content-addressable store（コンテンツ探索可能なストア）に配置されます。MacOS では ~/Library/pnpm/store/v3 がデフォルトの配置場所となりました。

node_modules に存在するすべてのパッケージに含まれるファイルは、コンテンツストアへのハードリンクです。

すべてのパッケージについて node_modules にハードリンクを作成したら、入れ子になった依存関係のグラフ構造を反映するシンボリックリンクを作成します。

実際に、node_modules ディレクトリは以下のようになっています。

node_modules/
└── .pnpm/
    └── body-parser@1.20.0
      └── node_modules
          ├── body-parser
          │   ├── index.js
          │   └── package.json
          ├── bytes -> ../../bytes@3.1.2/node_modules/bytes
          ├── content-type -> ../../content-type@1.0.4/node_modules/content-
          └── unpipe -> ../../unpipe@1.0.0/node_modules/unpipe
    └── express@4.18.1
      └── node_modules
          ├── body-parser -> ../../body-parser@1.20.0/node_modules/body-parser
          └── express/
├── express -> .pnpm/express@4.18.1/node_modules/express
└── .modules.yaml

このように npm や yarn と異なり、パッケージはすべてコンテンツ探索可能なストアに格納されるため、異なるプロジェクト間で同じバージョンのパッケージがある場合共有できます。そのためディスク容量を節約と、インストールの高速化が実現できます。

厳格なパッケージ管理

普段使用されている npm と異なり、node_modules 配下が奇妙な構造になっていることに気づいたでしょうか？pnpm は npm や yarn が採用しているフラットな node_modules の構造を採用していません。参考に、npm の生成する node_modules は以下のようになります。

node_modules/
├── body-parser
│   ├── index.js
│   └── package.json
├── express
│   ├── index.js
│   └── package.json

上記のように、npm の生成する node_modules は直下にすべてのパッケージを配置しています。

一方で、pnpm の場合には node_modules 直下に配置されているのは express のシンボリックリンクのみです。なぜなら、package.json の dependencies には express しか記載していないからです。この構造は、アプリケーションコードから直接アクセスできるパッケージは express だけということを意味します。

これが pnpm が厳格であることを表しています。

pnpm の厳格さを証明するために、実験をしてみましょう。まずは npm で express をインストールしたプロジェクトで以下のようなコードを作成します。

// npm-repo/index.mjs
import bodyParser from "body-parser";
import assert from "node:assert/strict";

assert.ok(bodyParser);

body-parser は直接インストールしたパッケージでないにも関わらず、import に成功して問題なくこのコードを実行できます。このように、フラットな構造の node_modules の場合には当該パッケージを直接インストールしていなくても、express が依存しているパッケージであればアクセスできます。

しかし、この挙動は次のような場合に問題となる可能性があります。

express のパッチバージョンアップで body-parser がメジャーバージョンアップされた
- 例えば、現在使用している body-parser のバージョンが 1.x でそのことを前提としてコードが書かれており、body-parser のバージョン 2.x が公開されたとします。しばらくの間は問題にならないのですが、experss のパッチバージョンアップで express が body-parser の 2.x を使用するように修正されたとしましょう。パッチバージョンアップなので、express 自体には破壊的変更はないはずですが、次回以降の npm install で body-parser の 2.0 が node_modules に配置されるようになります。これにより、何もしていないのも関わらず、body-parser に依存しているコードが壊れてしまう可能性があります。
express のパッチバージョンアップで body-parser に依存しなくなった
- 前述の例と同じように、experss がもはや body-parser に依存しなくなると node_modules に body-parser が配置されることはありません。この場合もまた body-parser に依存するコードは壊れてしまいます。

上記のような問題を防ぐ唯一の方法は、body-parser もまた明示的にインストールして使用することです。

一方 pnpm の場合はどうでしょう。さきほどと全く同じコードを実行しています。

// pnpm-repo/index.mjs
import bodyParser from "body-parser";
import assert from "node:assert/strict";

assert.ok(bodyParser);

結果として、モジュールが存在しないというエラーが表示されます。なぜなら、body-parser は package.json の dependencies に記載されていないため node_modules 直下には配置されておらず、node_modules/.pnpm 配下に存在するためです。

$ node index.mjs 
node:internal/errors:465
    ErrorCaptureStackTrace(err);
    ^

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'body-parser' imported from /work/pnpm-test/pnpm-repo/index.mjs
    at new NodeError (node:internal/errors:372:5)
    at packageResolve (node:internal/modules/esm/resolve:954:9)
    at moduleResolve (node:internal/modules/esm/resolve:1003:20)
    at defaultResolve (node:internal/modules/esm/resolve:1218:11)
    at ESMLoader.resolve (node:internal/modules/esm/loader:580:30)
    at ESMLoader.getModuleJob (node:internal/modules/esm/loader:294:18)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:80:40)
    at link (node:internal/modules/esm/module_job:78:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}

これを解決する正しい方法は、 body-parser をインストールすればよいのです。

$ pnpm add body-parser

パフォーマンス

npm、yarn、Yarn PnP と比較した pnpm のベンチマークが存在します。この結果を見る限り、確かに pnpm は非常に高速にパッケージをインストールできることがわかります。

action	cache	lockfile	node_modules	npm	pnpm	Yarn	Yarn PnP
install				35.3s	15.7s	16.7s	22.9s
install	✔	✔	✔	1.8s	1.1s	2.1s	n/a
install	✔	✔		10.3s	4.1s	6.5s	1.42
install	✔			14.9s	7.2s	11.1s	6.1s
install		✔		16.8s	12.6s	11.5s	17.2s
install	✔		✔	2.4s	2.7s	6.9s	n/a
install		✔	✔	1.8s	1.2s	7.1s	n/a
install			✔	2.3s	7.8s	11.7s	n/a
update	n/a	n/a	n/a	1.9s	9s	15.4s	28.3s