chezmoi で dotfiles を管理するときに便利な機能についてまとめる
はじめに
これまで ganyariya は自分流のシェルスクリプトで dotfiles を運用していました。
しかし、設定ファイルを継ぎ足しで修正していった結果、使用していない設定も増えて汚れた状態になってしまいました。
そのため、 dotfiles を chezmoi という dotfiles 管理ツールを利用して、ゼロから dotfiles を作り直しました。
この記事では dotfiles を chezmoi をもちいて置き換えるうえで、便利だなと思った機能についてまとめます。
できあがった dotfiles
debian image における chezmoi apply の実行です。
全体で 3 分ほどかかっており、特に大部分を占めているのが neovim の build です。
しかし neovim 以外は 1 分程度でセットアップが完了しており、 今後のクラウド linux vm でも活用できそうです。
この記事で取り扱う・取り扱わないこと
chezmoi の概要や chezmoi の基本構成などについては書きません。
公式サイトや以下の記事を参考にしてください。
かわりに chezmoi で dotfiles を取り扱ううえでこの機能便利だなと思った、検索しづらい・見つけづらい機能についてまとめようと思います。
.chezmoiignore
.chezmoiinogre を利用する個で、chezmoi で管理したくないファイルやディレクトリを指定できます。
自分の場合 .config/tmux/tmux.conf 以外の tmux ファイルは chezmoi で管理しない設定をしています。
これによって chezmoi add .config/tmux を実行しても tmux.conf のみ dotfiles ディレクトリで変更が追跡されます。
# tmux
.config/tmux/*
!.config/tmux/tmux.conf
.chezmoiexternal.toml
dotfiles 管理外である、外部リポジトリや外部パッケージを自動的に引っ張ってこれます。
つまり、 chezmoi apply を実行したときに外部リポジトリなどを chezmoi が勝手にダウンロードして適切なパスに置いてくれます。
自分の場合は以下 2 つを現在 chezmoiexternal で管理しています。
- tmux のプラグインマネージャである tpm
- neovim のフレームワークである AstroNvim
たとえば nvim の場合、 .config/nvim パスに depth=1 かつ main ブランチの AstroNvim リポジトリを持ってこれます。
[".tmux/plugins/tpm"]
type = "archive"
url = "https://github.com/tmux-plugins/tpm/archive/master.tar.gz"
exact = true
stripComponents = 1
refreshPeriod = "168h"
[".config/nvim"]
type = "git-repo"
url = "https://github.com/AstroNvim/AstroNvim"
refreshPeriod = "24h"
clone.args = ["--depth", "1", "-b", "main"]
ganyariya/dotfiles で直接 AstroNvim のリポジトリを submodule として管理するということも考えました。
(ganyariya/dotfiles/dot_config/nvim に submodule として登録する)
しかし、 dotfiles リポジトリで chezmoi apply を実行すると、 submodule に含まれる . 拡張子が sync されませんでした。
つまり、 AstroNvim リポジトリ内の . から始まるファイルが sync されず、 ~/.config/nvim に含まれませんでした。
そのため chezmoi で外部リポジトリや外部パッケージを扱う際は .chezmoiexternal.toml を利用したほうがよいかなと思います。
ユーザスクリプト
dotfiles で実現したい機能として以下 2 種類があります。
-
.zshrcや.gitconfigなどの設定ファイルを他環境でも手軽に利用する -
ripgrepやcurltmuxなど、自分が利用するコマンド・パッケージを用意する（環境構築）
1 の「設定ファイルを他環境でも手軽に利用する」については、 chezmoi add .zshrc などをすれば自動的に配置されるため特に工夫しなくてよいです。
しかし、ripgrep curl など自分が利用したいコマンド・パッケージの環境構築は自動では行えません。
なにかしらのパッケージマネージャを利用して、これら依存パッケージをインストールする必要があります。
chezmoi ではこの「依存パッケージの自動インストール」の実現方法として、 User Script（ユーザスクリプト）があります。
chezmoi では dotfiles リポジトリにおける任意のディレクトリにおいて run_once_ から始まるテキストファイルを ユーザスクリプト として認識します。
そして、 chezmoi apply --init 時にそれらユーザスクリプトを自動的に実行し、「実行したこと」も state として保存します。
そのため、 環境構築のために一度だけパッケージをインストールできます。
たとえば自分の場合、 Mac HomeBrew によるコマンドのインストールをユーザスクリプトで実現しています。
chezmoi apply を実行すれば自動的に .Brewfile を読み込んで ripgrep tmux などをよしなに導入してくれます。
ユーザスクリプトの配置
ユーザスクリプトの配置について自分の場合、完全に OS (Distribution) ごとにセットアップスクリプトを分岐することにしました。
これは 1 つのユーザスクリプトのなかで、 mac, linux, windows の環境を構築するのはしんどいためです。
また、 OS (Distribution) ごとに設定したい項目も異なるため完全に分離しています。
各環境で利用したいスクリプトを分けるために .tmpl を利用しており、 一致する OS の場合のみユーザスクリプトを実行するようにしています。
以下の場合 mac (darwin) のみで実行され、 debian ではスキップされます。
#!/bin/bash
{{ if eq .chezmoi.os "darwin" }}
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew bundle --file="$HOME/.Brewfile"
{{ end }}
tmpl については以下を参照ください。
ユーザスクリプトの実行順序
ユーザスクリプトは辞書順で実行されるそうです。
そのため、実行したいユーザスクリプト順で 01, 02, 03 と prefix をつけるようにしています。
最後に
chezmoi を導入することによって、ワンライナーで環境を構築できるようになりました。
（mac ではまだ試せていませんがおそらくできるはず...）
sh -c "$(curl -fsLS get.chezmoi.io)" -- -b $HOME/bin init --apply ganyariya
apt update && \
apt install -y curl git zsh && \
chsh -s /usr/bin/zsh && \
sh -c "$(curl -fsLS get.chezmoi.io)" -- -b $HOME/bin init --apply ganyariya
chezmoi によってより気楽に dotfiles が運用でき環境差分を吸収できるようになったため、便利コマンドや alias をどんどん設定していこうと思います。
Discussion