Skip to content

Commit a9e7442

Browse files
committed
add: ADR
1 parent 9bc5bb8 commit a9e7442

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# 2025-01-11 yanmanoku.github.io のパッケージマネージャを yarn から pnpm に変更する
2+
3+
## Status
4+
5+
Accepted.
6+
7+
## Context
8+
9+
[yamanoku.github.io](https://github.com/yamanoku/yamanoku.github.io) のパッケージマネージャは長らく Yarn を使用している。
10+
11+
Yarn Classic から Yarn Berry への変更があってからも最新版に追従するようにしているが、Yarn Berry からのバージョン管理として扱われていた Corepack が [Node.js 内から基本導入するのを廃止する動き](https://socket.dev/blog/node-js-takes-steps-towards-removing-corepack)があったり、現在 Yarn Berry の機能を大いに活用できているわけでもなく、他パッケージマネージャへの移行も検討している。
12+
13+
ちなみに yamanoku の他の OSS では基本的に npm を導入し、実験的に pnpm を使用している。
14+
15+
- Yarn: yamanoku.github.io
16+
- pnpm: [vuefes-japan-speakers](https://github.com/yamanoku/vuefes-japan-speakers)
17+
- npm: そのほか多数([Link](https://github.com/search?q=org%3Ayamanoku+package-lock.json+language%3AJSON&type=code&l=JSON)
18+
19+
npm だったものではかつて Yarn Classic だったものもあるが、ワークスペースを活用していない単一のリポジトリのため、標準に準拠するという意味で Node.js デフォルトのパッケージマネージャである npm に変更した。その後大きな問題はないものとしてそのまま活用できている。
20+
21+
現在の yamanoku.github.io ではドキュメントサイトとしてのほかに [yama-normalize](https://github.com/yamanoku/yamanoku.github.io/tree/9bc5bb8f12e17125042088fa68348b41f12a67a2/packages/yama-normalize) をモノレポ管理している。これは Yarn の Workspaces 機能を活用している。この機能自体はほかのパッケージマネージャでも実現できる。
22+
23+
ドキュメントのリポジトリが分散していることもあり、これらをまとめるほか今後同様にモジュールが増えてモノレポとしての管理が増えていく可能性はある。
24+
25+
## Decision
26+
27+
Yarn Berry から pnpm にパッケージマネージャを変更する。
28+
29+
以下は検討事項としてパッケージマネージャの特徴や選定理由を記載する。パッケージマネージャ名となりのバージョンは執筆時点のものになる。
30+
31+
### Yarn Berry (v4.6.0)
32+
33+
[Yarn ホームページ](https://yarnpkg.com/)
34+
35+
現在の採用しているパッケージマネージャ。npm のサードパーティとしてのパッケージマネージャで、開発自体は継続している。[パフォーマンスなども向上している](https://yarnpkg.com/features/performances)が、機能的なものとして大きな特徴があるわけでもないため継続することにはさほどメリットがないように考えている。また、Corepack を有効化しないと現行 Yarn のバージョン管理も動作しないため、その辺りも考慮すると他パッケージマネージャへの移行も検討したほうがよいと判断している。
36+
37+
### npm(v11.0.0)
38+
39+
[npm ドキュメントページ](https://docs.npmjs.com/)
40+
41+
Node.js デフォルトのパッケージマネージャ。Yarn Classic の登場時には機能面・速度面でも劣っていたが、現状は大きな差はできていなように思われる。
42+
43+
標準準拠という視点で安定性があり、バージョン管理は Corepack を活用しなくてもよく、ほかの yamanoku OSS とで揃えられるメリットがある。パッケージマネージャとしての標準であり、保守的な運用をする意味での採用は大いにあり得る。
44+
45+
### pnpm(v10.0.0)
46+
47+
[pnpm ホームページ](https://pnpm.io/ja/)
48+
49+
pnpm も Yarn と同様の npm サードパーティのパッケージマネージャである。シンボリックリンクを活用したモジュールのバージョン管理を容易にして、機能として [npm よりもできることが多い](https://pnpm.io/ja/feature-comparison)。さらに pnpm では [v10 より Corepack を使用せずに package.json 内でバージョン管理がデフォルトでできるようになった](https://github.com/pnpm/pnpm/releases/tag/v10.0.0#:~:text=manage%2Dpackage%2Dmanager%2Dversions%3A%20enabled%20by%20default.)。また、[State of JS 2024](https://2024.stateofjs.com/ja-JP/libraries/monorepo_tools/) のモノレポツールでは pnpm の利用率・満足度1位評価を受けている。
50+
51+
開発速度でいうとこれまであげたパッケージマネージャの中で最も速く、追従していくとなると大変ではあるが、[Renovate](https://github.com/renovatebot/renovate) を活用して追従して CI でチェックしていくことでリポジトリ内の健全性は保てると考えられる。
52+
53+
### Deno, Bun
54+
55+
ちなみにパッケージマネージャとしての選択肢であれば Deno や Bun も挙げられる。
56+
57+
- Deno は現在 [npm モジュール互換](https://docs.deno.com/runtime/fundamentals/node/#using-npm-packages)ができるようになっているのと、[ロックファイルを作成することが可能](https://docs.deno.com/runtime/fundamentals/modules/#integrity-checking-and-lock-files)[Workspacesやモノレポ管理機能](https://docs.deno.com/runtime/fundamentals/workspaces/)もある
58+
- Bun でも同様に [npm モジュールからのマイグレーション](https://bun.sh/guides/install/from-npm-install-to-bun-install)ができるようになっているのと、[ロックファイルを作成することが可能](https://bun.sh/docs/install/lockfile)[Workspaces 機能](https://bun.sh/guides/install/from-npm-install-to-bun-install#workspaces-yes)もある
59+
60+
ただしこの2つはあくまでもランタイムとしての存在であり、パッケージマネージャとしての機能は付属的なものである。yamanoku.github.io で扱うランタイムを Node.js から変更する際には候補として挙げるとして、今回からは選定より外す。
61+
62+
## References
63+
64+
- [node_modulesの問題点とその歴史 npm, yarnとpnpm](https://zenn.dev/saggggo/articles/dbd739508ac212)
65+
- [pnpm の node_modules を探検して理解しよう - ドワンゴ教育サービス開発者ブログ](https://blog.nnn.dev/entry/2024/05/10/110000)
66+
- [pnpm v10 で corepack 不要で pnpm 自身のバージョン管理が可能に](https://zenn.dev/euxn23/articles/399a6815ddac93)

0 commit comments

Comments
 (0)