🧶

yarnのメジャーバージョン1を使いつつcorepackによるバージョン制御はできない

2022/07/12に公開約4,900字

確認したバージョン

yarn 1系統: 1.22.19 (以降v1と記す)
yarn 3系統:   3.2.1 (以降v3,最新stableと記す)

伝えたいこと

  1. yarnのインストール方法や設定ファイルなどのv1とv3で大きく差がある
  2. dependabotがまだv3に対応できていない
  3. v1を使いつつ少しでも設定を最新stableに寄せられないかな〜?→できません🙅‍♀️

はじめに

yarnはすでにメジャーバージョンが3になっています。それどころか4のrc版も出ています。

またv1とv3の公式サイトやGithubリポジトリも分かれており、v1にはThe 1.x line is frozenや機能改善は行わない旨などが記されています。
これらのことから積極的に最新stableに更新したいなと思いましたが、一時断念しました。
その調査で得た気づきがあったので共有したいと思います。

yarnのバージョンに関連する前提知識

  • バージョンを確認するコマンド: yarn -v
    • 他にもyarn installを実行すると一番最初のログとして表示されます
  • バージョンを設定するコマンド: yarn set version 〇〇
    • 〇〇にはstable, classic, もしくはバージョン番号を指定することができます
  • yarnのバージョンはコマンドを実行するディレクトリで変化する
    • yarnにはグローバルインストールされているバージョンとは別に、プロジェクト(ディレクトリ)が依存するバージョンを指定できます
    • ディレクトリの.yarn/releases/以下に指定したバージョンのyarnスクリプトが配置され使われる感じです。便利ですね

yarn v1とv3のインストール方法や設定ファイルの違い

上記の前提知識はv1,v3は関係ありませんが、機能以外にもインストール方法や設定ファイルも明確に違ってきます。

インストール方法

  • v1のインストール方法:
npm install --global yarn

https://classic.yarnpkg.com/en/docs/install#mac-stable
  • v3のインストール方法:
corepack enable
yarn set version stable

https://yarnpkg.com/getting-started/install

余談1: corepackとは?

nodejsのv16.9.0, v14.19.0から搭載された機能です。
package.jsonpackageManagerフィールドでそのプロジェクトが何のパッケージマネージャのどのバージョンに依存するか指定することができます。

https://nodejs.org/api/corepack.html
  "packageManager": "yarn@3.2.1"

と指定されていればpnpmでパッケージをインストールしようとするとエラーになるという機能です。(corepack enableのコマンド実行が必要になります。)

しかし残念ながらnpmはデフォルトではcorepackの管理下に置かれないのでnpm installを実行してもエラーにならないという罠があります。
corepack enable npmを実行することでnpmも管理に追加されます。

設定ファイル

  • v1: .yarnrc
  • v3: .yarnrc.yml

これらのファイルはファイル名だけでなく、フォーマットにも違いがあります。

プロジェクトルートにどちらのファイルが設置されていたとしてもyarnバージョンによって使われるファイルが切り替わります。

yarn.lockファイル

yarn.lockファイルは人間が更新するファイルではありませんが、このファイルのフォーマットがバージョンによって変化します。
v3に更新してからyarn installを実行することで勝手にマイグレーションしてくれます。
ファイルを消す必要はありません。

以上のことから…

yarnはv1とv3を同じプロジェクトで混ぜて使うことができないことが分かりました。
同じメジャーバージョンの間でマイナーバージョンが変わるのとは違い、そのプロジェクトごとにマイグレーション対応が必要なんですね。
詳しいマイグレーションガイドはv3公式サイトから確認できます。

しかしながら次のことから私は一旦対応を諦めました。

dependabotがまだv3に対応できていない

dependabotとは、Githubで利用できる依存関係更新の仕組みです。
これを有効にしているとnodejsプロジェクトだけでなく様々なエコシステムの依存関係更新のPRを作ってくれます。
便利なので有効にしていることも多いかと思われますが、残念ながらv1のyarn.lcokのフォーマットしか対応していません。

サポート追加要望Issueを見るといくつか対処方法がありました。

  • 同様のサービスであるrenovatebot/renovateに乗り換える
  • dependabotが作るPRをトリガーにして差分を更新するGithub Actionを設定する

renovateも良さそうですが、プロジェクトによっては同じリポジトリの中で複数のエコシステムを含んでいたりしてnodejsだけ別の仕組みを使い始める気持ちにはあまりなれませんでした。
Github Action追加が現実的でしたがまだ試せていなかったです。

そこでv1を使いながらcorepackの仕組みを寄せておけば将来的にv3に上げられたとき対応が楽になるかな〜と思い、調査してみました。

結論: yarnのv1を使いつつcorepackによるバージョン制御はできない

v1の公式サイトにはcorepackを使える・使えないは一切書かれていないので、もしかしたら使えるかもな〜ぐらいの気持ちで調査してみました。
結果としては「corepack関連を更新するのはv3を使いつつyarn set versionするときだけでv1では更新されない」ということが分かったので、v1利用時ではcorepackを利用するのは諦めました。
試したコマンドについては下記に書いておきます。ただしグローバルインストールされているバージョンやどのディレクトリでコマンド実行するかで挙動が変わる恐れがあるため、再現性は保証できません。

`corepack`関連を更新するのはv3を使いつつ`yarn set version`するときだけでv1では更新されない
yarn -v
> 1.22.xx # グローバルインストールされているyarnはv1

# corepackを有効にしておく
corepack enable yarn

mkdir test && cd test
# package.jsonを作る。v1の状態では`packageManager`フィールドは指定されない
yarn init -y

# versionをv1に明示的に設定する
yarn set version 1.22.19
# v1にsetしてもpackage.jsonは更新されない。ただし設定ファイルである`.yarnrc`と`.yarn`ディレクトリが作られる

yarn -v
> 1.22.19

# 最新系にsetするとpackage.jsonが更新される
# なおこの際に`yarn.lock`ファイルが必須。v3からはlockファイルがないとそのディレクトリをプロジェクトルートと認識せずlockファイルが見つかるまで上位ディレクトリを探しにいってしまう
touch yarn.lock
yarn set version 3.2.1
# `.yarn/releases/`が更新され、`.yarnrc.yml`が追加される

# またpackage.jsonに`packageManager`フィールドが追加される
cat package.json
> {...
> "packageManager": "yarn@3.2.1"
> ...}

yarn -v
> 3.2.1

# 逆にv3からv1に戻してみる
yarn set version 1.22.19

yarn -v
> 1.22.19

# package.jsonの`packageManager`フィールドはv1に更新される
# v3用の設定ファイル`.yarnrc.yml`の設定も更新される
cat package.json
> {...
> "packageManager": "yarn@1.22.19"
> ...}
cat .yarnrc.yml
> yarnPath: .yarn/releases/yarn-1.22.19.cjs

# アレ?v1でもcorepack使えてるっぽい:thinking:と思うが…
# ここでv1の別のバージョンに設定してみる
yarn set version 1.22.18

# `yarn -v`は`1.22.19`何故か更新されない!!!
# package.jsonの`packageManager`は`1.22.19`のまま更新されない
# `.yarnrc.yml`は`1.22.19`のまま更新されない
# `.yarnrc`は`1.22.18`で更新されている!?

以上のことから分かることとして…

  • yarn set versionを実行したときのyarnバージョンによって更新されるファイルは変わる
  • v1を使いつつcorepackの仕組みに寄せても挙動が直感的でない。v1を使いつつcorepackによるバージョン制御は意図された挙動でない可能性がある

ここで注意してほしいのがyarn set versionコマンドがそのディレクトリがyarnが管理すべきディレクトリと判断するまでどんどん上位のディレクトリを探しにいって、最終的にユーザルートディレクトリに設定ファイルを残したりすることがあります。
上位のディレクトリに変な設定ファイルがあると下位ディレクトリにも影響が出たりするので、なんかへんだなと思ったら上位ディレクトリを疑ってほしいです。
こまったらyarnを再installしてみるといいです。

終わりに

yarnのバージョンアップはdependabotの対応を待ってからで一旦はいいかなという気持ちになりました。
上記で紹介したdependabotのv2サポート追加Issueは最近(2022/7)いい方向に進んでいそうなので案外すぐ更新できるかもしれませんね。

以上

Discussion

ログインするとコメントできます