Brewfile の妥協：Mac アプリは結果整合性で管理する

このレイヤーでは差分を許している#

レイヤー 3——プロジェクトの依存関係には厳密な整合性が必要になる。lockfile が指定するバージョンと開発環境の実物が違えば、ビルドが失敗するかもしれない。手元だけ動いて CI では挙動が変わることもある。影響はすぐに現れ、ときには他の人まで巻き込むため、バージョンの固定や再現可能なインストールに手間をかける価値がある。

一方の レイヤー 0——システムには、Homebrew で入れたアプリやコマンドラインツールがある。今日 brew install を実行して Brewfile への追記を忘れても、今使っている Mac はそのまま動く。たいてい気づくのは、後日 Brewfile から新しい環境を復元したときだ。足りないツールをインストールし、忘れていた一行を追加すれば済む。

コストはゼロではないものの、発生するのは後で、しかも通常は小さい。そのため、普段の差分は許し、定期的に照合して収束させている。プロジェクト依存関係のような強い整合性ではなく、ここでは結果整合性を使う。

インストール元の選び方#

macOS では、次の順番でインストール元を選んでいる。

最初に探すのは Homebrew だ。コマンドラインツールなら formula、GUI アプリなら cask を使う。この構成では Homebrew がすでにレイヤー 0 の管理元であり、どちらの brew インストールも Brewfile に簡単に記録できる。

次が mas-cli 経由の Mac App Store。iCloud 同期、ファミリー共有、App Store のレシートに依存するアプリ、またはストアでしか配布されていないアプリは mas から入れる。それ以外は cask のほうが扱いやすい。他のツールと同じ brew コマンドで更新でき、App Store にサインインしたアカウントにも依存しないからだ。

ベンダーサイトから配布される .dmg は最後の手段になる。Brewfile には書けないため、アプリ名と入手元を manual-installs.md に残している。これがなければ、Brewfile で管理できていないものは自分の記憶にしか残らない。

目標の状態は一つのファイルに置く#

mas-cli を使うと、App Store アプリの mas エントリも formula や cask と同じ Brewfile に置ける。

1
# Brewfile
2
tap "homebrew/bundle"
3

4
brew "ripgrep"
5
brew "mas"
6

7
cask "visual-studio-code"
8
cask "rectangle"
9

10
# App Store apps, by their numeric ID (mas list to find them)
11
mas "Things 3", id: 904280696
12
mas "Xcode", id: 497799835

brew bundle を一度実行すれば、formula、cask、App Store アプリをまとめてインストールできる。シリーズ最初の記事で扱った所有関係と同じく、この Mac に何を入れるべきかは一つのファイルで宣言する。実際の Mac より一時的に遅れることはあっても、宣言された目標状態が複数になるわけではない。

定期的に差分を確認する#

結果整合性と呼ぶなら、いつか本当に収束させる必要がある。私はまず brewdiff という読み取り専用のヘルスチェックを使う。インストール済みだが未宣言のものと、宣言済みだが未インストールのものを両方表示する関数だ。

1
# 30-functions.zsh — show drift between the Brewfile and the machine
2
brewdiff() {
3
  local brewfile="${HOMEBREW_BUNDLE_FILE:-$HOME/.config/homebrew/Brewfile}"
4
  echo "== Installed but NOT in Brewfile (undeclared) =="
5
  brew bundle cleanup --file="$brewfile" 2>/dev/null \
6
    | grep -E '^(Would uninstall|brew|cask|mas)' || echo "  (none)"
7
  echo
8
  echo "== In Brewfile but NOT installed (missing) =="
9
  brew bundle check --file="$brewfile" --verbose 2>/dev/null \
10
    | grep -v '^The Brewfile' || echo "  (all installed)"
11
}

この関数は表示するだけで、Mac の状態を変更しない。未宣言の項目を一つずつ見ながら、残すつもりだったのに書き忘れたツールなのか、削除してよい実験用のツールなのかを判断できる。

通常の formula には brewadd を使う。パッケージをインストールし、成功したら同じ操作の中で Brewfile に追記するための短い関数だ。

1
# install AND declare in one step
2
brewadd() {
3
  local brewfile="${HOMEBREW_BUNDLE_FILE:-$HOME/.config/homebrew/Brewfile}"
4
  brew install "$@" || return 1
5
  for pkg in "$@"; do
6
    grep -q "\"$pkg\"" "$brewfile" || echo "brew \"$pkg\"" >> "$brewfile"
7
  done
8
}

コマンドを用意しても、実行を忘れれば意味がない。そこで shell の起動時にタイムスタンプの古さを調べ、30 日を超えていたら知らせるようにした。

1
# remind me to reconcile if it has been > 30 days
2
_brewdiff_reminder() {
3
  local stamp="$HOME/.cache/brewdiff-last"
4
  if [[ ! -f "$stamp" ]] || \
5
     [[ $(find "$stamp" -mtime +30 2>/dev/null) ]]; then
6
    print -P "%F{yellow}brewdiff:%f it's been a while — run 'brewdiff' to reconcile"
7
  fi
8
}
9
_brewdiff_reminder

brewdiff の実行後には、最後にタイムスタンプを touch して時計をリセットする。月に一度の確認を先延ばしにしないよう、仕組みは意図的にこれ以上複雑にしていない。

Brewfile の適用には、dotfiles の記事で使った chezmoi の構成をそのまま使える。run_onchange_ スクリプトによって、新しい Mac へのインストール時と Brewfile の内容が変わったときに brew bundle を実行する。

1
# run_onchange_brew-bundle.sh.tmpl
2
#!/bin/sh
3
# Brewfile hash: {{ include "dot_config/homebrew/Brewfile" | sha256sum }}
4
brew bundle --file="$HOME/.config/homebrew/Brewfile"

スクリプトを起動する仕掛けは、コメント内のハッシュにある。Brewfile のチェックサムが変わるとこの行も変わるため、chezmoi は編集後にコマンドを再実行する。

AI には監査だけを頼む#

月次確認では、brewdiff の出力を AI agent に渡すこともある。未宣言のパッケージが何なのかを説明し、残すか削除するかを理由付きで提案してもらう。ただし、Brewfile 自体は編集させない。

たとえば「pngquant は画像圧縮ツールで、一度しか使っていないように見えるので削除を検討してよい」と分かれば、調査時間を減らしつつ最終判断は自分に残せる。agent が直接ファイルを書き換えると、情報源を変更できる主体が二つになり、Brewfile は私の意図だけを表すものではなくなる。任せているのは判断材料の整理であって、変更する権限ではない。

自動化しないコマンド#

brew bundle cleanup と --cleanup フラグは、Brewfile にないものをすべてアンインストールする。宣言が完成した後なら便利だが、普段使うツールの半分がまだ未宣言なら危険だ。brewdiff の未宣言リストが短くなり、各項目を自分で把握できるまでは --force を付けて実行しない。

この月次確認は、メンテナンスの記事に書いた習慣の一例でもある。差分を見えるようにし、内容を確認してから、決めた周期で収束させる。Mac アプリについてはこれで十分だった。インストールのたびに Brewfile を即座に更新する必要はないが、書き忘れたものは見える状態にし、後から小さな手間で直せるようにしておきたい。