究極のzshプラグイン読み込み高速化: プラグインマネージャーの限界を越えろ【起動時間14.6ms】
このような記事をご覧の皆様におかれましては、日々盆栽を丹念に育て、自身だけの最強開発環境を追求していることと存じます。 皆様であればプラグインの読み込みが起動時間に影響を及ぼさないよう、プラグインの遅延起動を設定していることでしょう。しかし、プラグインマネージャー自体の起動時間を気にしたことはございますでしょうか。 今回は、プラグインマネージャーの読み込みを回避してプラグインを読み込むことにより、zshをさらに高速起動する手法を共有します。これにより、我々の盆栽は疾風の如く立ち昇り、開発の絶え間ない流れを切り裂く、驚異的なスピードを得ることでしょう。
概要
- プラグインマネージャーの結果だけ取っておいて普段は起動しないようにしよう
- 遅延はzsh-deferでかけるよ
- 全部zcompileすれば最速
制約
本テクニックは基本的に外部バイナリのプラグインマネージャーに適しており、.zsh実装のプラグインマネージャーではうまく行かないはずです。
本記事ではsheldonプラグインマネージャーを使用します。
よかったsheldonの紹介記事
前提: sheldonの設定 & 遅延ロード
プラグインのインストール設定についてはよくできた先行記事がありますし、今回のテクニックの本題ではないので大雑把に行きます。この記事だけを読んでの設定はおすすめできません。
さて、高速な起動のためには遅延ロードはほぼ必須です。zinitにはプラグインマネージャー組み込みの遅延ロードがありますが、sheldonには組み込まれてはいません。代わりに、コマンドの遅延実行を提供するプラグインであるzsh-deferを使います。(sheldon docs上で紹介されている方法です。)
sheldonではプラグインの設定はtomlファイル(デフォルトで~/.config/sheldon/plugins.toml)で、次のような感じで書きます。
shell = "zsh"
[templates]
defer = "{{ hooks | get: \"pre\" | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks | get: \"post\" | nl }}"
[plugins.zsh-defer]
github = "romkatv/zsh-defer"
[plugins.xxx]
github = 'xxx/xxx.zsh'
apply = ["defer"]
hooks.pre = 'zsh-defer source $HOME/.config/zsh/hook/xxx_pre.zsh'
hooks.post = 'zsh-defer source $HOME/.config/zsh/hook/xxx_post.zsh'
templates下deferで定義しているのがzsh-deferを用いた遅延ロードの設定です。
sheldonではtemplatesを用いてプラグインの読み込み処理を自由に定義することができ、ここではただ単にsourceする代わりにzsh-defer sourceでsourceを遅延実行するテンプレートを定義しています。
読み込みは設定ファイルでの列挙順に行われるので、一番最初にzsh-deferを書き、その下からはzsh-deferによって遅延ロードするように書いていきます。apply = ["defer"]がdefer templateを使用するように宣言している部分です。
ただし、全てのプラグインが遅延できるわけではないので、一部の仕方ないやつは通常の読み込みになります。
ところで、2023年5月16日のsheldon 0.7.3 (リリースノート) からhooksオプションが追加されていました。これにより、プラグインの読み込み前後の処理を挿入するのがスマートに書けるようになりました。やったぜ。
本題: プラグインマネージャーの読み込みを回避してプラグインを読み込む方法
sheldonプラグインマネージャーはsheldon sourceの実行でプラグインをzshに読み込ませるためのスクリプトを吐きます。
❯ sheldon source
source "<path to zsh-defer>"
zsh-defer source "<path to plugin a>"
zsh-defer source "<path to plugin b>"
.
.
.
これをevalに渡すのが通常の読み込みです。
eval "$(sheldon source)"
しかし、これを毎回やるのはロスです。sheldon sourceで出力されるスクリプトが変化するのは設定が変化した時のみなので、毎回プラグインの構成を変える人でもない限り、ほぼ毎回結果の変わらない無駄な処理です。
そこで、sheldon sourceの出力をキャッシュファイルに取っておいて、普段はそれをsourceするだけにすれば、起動が高速化できます。そのためには.zshrcに次のようなことを書きます。
# ファイル名を変数に入れる
cache_dir=${XDG_CACHE_HOME:-$HOME/.cache}
sheldon_cache="$cache_dir/sheldon.zsh"
sheldon_toml="$HOME/.config/sheldon/plugins.toml"
# キャッシュがない、またはキャッシュが古い場合にキャッシュを作成
if [[ ! -r "$sheldon_cache" || "$sheldon_toml" -nt "$sheldon_cache" ]]; then
mkdir -p $cache_dir
sheldon source > $sheldon_cache
fi
source "$sheldon_cache"
# 使い終わった変数を削除
unset cache_dir sheldon_cache sheldon_toml
これで、キャッシュ (~/.cache/zsh/sheldon.zsh) が存在していない、またはキャッシュが設定ファイルよりも古い場合にsheldon sourceを実行してキャッシュの作成をしてくれます。
補足1: sourceされる全てのファイルをzcompileしてさらに高速化
これ単体でも独立したトピックとして成立するので記事を分けさせていただきました。
sourceコマンドを乗っ取ることでプラグインなども全てzcompileしちゃうぜという記事です。
補足2: zsh-deferはプラグイン読み込み以外でも使える
zsh-deferで遅延できないコマンドは一部ありますが、多くは遅延できます。
私は遅延させる設定を置くlazy.zshと遅延できなかった設定を置くnonlazy.zshを用意しておき、基本的に新しい設定はまずlazy.zshに書き、うまく行かなければnonlazy.zshに移動させることにしています。
後からでもいい設定を遅延させて読み込むことで、極めて早いファーストビュー、入力受付を得ることができます。
個人的なおすすめ: 設定はディレクトリにまとめてしまえ
起動速度には関係ありませんが、今回の記事を書きながら設定をいじっていると設定ファイルが複数の場所に分散しているのがやりにくいと感じ、 ~/.config/zsh 以下にzshの設定をまとめて置いて、.zshrcだけホームにシンボリックリンクを張ることにしました。
また、sheldon君はデフォルトでは ~/.config/sheldon を使おうとするのですが、これだとzshの設定としては分散された配置になるので良くないです。環境変数SHELDON_CONFIG_DIRで場所を直せるので、 ~/.config/zsh/sheldon/ 下に入ってもらうことにしました。
合体
本記事を執筆した時点での私の .zshrc は次のようになっています。少し手が入っていますが、おおよそ以上の内容を合わせたものになっています。
ZSHRC_DIR=${${(%):-%N}:A:h}
# source command override technique
function source {
ensure_zcompiled $1
builtin source $1
}
function ensure_zcompiled {
local compiled="$1.zwc"
if [[ ! -r "$compiled" || "$1" -nt "$compiled" ]]; then
echo "\033[1;36mCompiling\033[m $1"
zcompile $1
fi
}
ensure_zcompiled ~/.zshrc
# sheldon cache technique
export SHELDON_CONFIG_DIR="$ZSHRC_DIR/sheldon"
sheldon_cache="$SHELDON_CONFIG_DIR/sheldon.zsh"
sheldon_toml="$SHELDON_CONFIG_DIR/plugins.toml"
if [[ ! -r "$sheldon_cache" || "$sheldon_toml" -nt "$sheldon_cache" ]]; then
sheldon source > $sheldon_cache
fi
source "$sheldon_cache"
unset sheldon_cache sheldon_toml
source $ZSHRC_DIR/nonlazy.zsh
zsh-defer source $ZSHRC_DIR/lazy.zsh
zsh-defer unfunction source
手が入っているポイントは ensure_zcompiled でのメッセージ表示の "compiling" を色付きで表示するようにしたことと、sheldon source のキャッシュを $SHELDON_CONFIG_DIR に置くことにしている点です。
ファイルの配置は次のようになっています。
~/.config/zsh/
│ plugrc/
│ │ xxxxxx <-- プラグイン関連の設定ファイルを配置する
│ └ xxxxxx
│ sheldon/
│ │ .gitignore <-- plugins.lock, sheldon.zshをignoreする
│ │ plugins.lock
│ │ plugins.toml
│ │ sheldon.zsh
│ └ sheldon.zsh.zwc
│ .gitignore <-- *.zwcをignoreする
│ .zshrc
│ lazy.zsh
│ lazy.zsh.zwc
│ nonlazy.zsh
└ nonlazy.zsh.zwc
効果の検証
一応、効果のほどを示しておきます。ただし、当然ですが全ての環境で同等の効果を保証するものではありません。ベンチマーク時点のzshrcディレクトリは以下。
環境は以下。neofetchからの切り抜きです。
簡単に言えば2018年の普通のノートにメモリを32GB積んだやつにArch Linuxが入っています。
OS: Arch Linux x86_64
Kernel: 6.4.12-zen1-1-zen
Shell: zsh 5.9
Terminal: tmux
CPU: Intel i5-8250U (8) @ 3.400GHz
GPU: Intel UHD Graphics 620
Memory: 5466MiB / 31859MiB
両テクニック不使用
.zshrcおよびベンチマーク詳細
ZSHRC_DIR=${${(%):-%N}:A:h}
export SHELDON_CONFIG_DIR="$ZSHRC_DIR/sheldon"
eval "$(sheldon source)"
source $ZSHRC_DIR/nonlazy.zsh
zsh-defer source $ZSHRC_DIR/lazy.zsh
❯ hyperfine -w 5 -r 50 'zsh -i -c exit'
Benchmark 1: zsh -i -c exit
Time (mean ± σ): 39.2 ms ± 0.5 ms [User: 27.9 ms, System: 11.9 ms]
Range (min … max): 38.5 ms … 40.5 ms 50 runs
平均 39.2 ms
標準偏差 0.5 ms
sheldonの出力をキャッシュするテクニックを使用
.zshrcおよびベンチマーク詳細
ZSHRC_DIR=${${(%):-%N}:A:h}
export SHELDON_CONFIG_DIR="$ZSHRC_DIR/sheldon"
sheldon_cache="$SHELDON_CONFIG_DIR/sheldon.zsh"
sheldon_toml="$SHELDON_CONFIG_DIR/plugins.toml"
if [[ ! -r "$sheldon_cache" || "$sheldon_toml" -nt "$sheldon_cache" ]]; then
sheldon source > $sheldon_cache
fi
source "$sheldon_cache"
unset sheldon_cache sheldon_toml
source $ZSHRC_DIR/nonlazy.zsh
zsh-defer source $ZSHRC_DIR/lazy.zsh
❯ hyperfine -w 5 -r 50 'zsh -i -c exit'
Benchmark 1: zsh -i -c exit
Time (mean ± σ): 20.1 ms ± 0.5 ms [User: 12.5 ms, System: 8.1 ms]
Range (min … max): 19.6 ms … 22.4 ms 50 runs
平均 20.1 ms
標準偏差 0.5 ms
sourceをオーバーライドして全てをzcompileするテクニックを使用
.zshrcおよびベンチマーク詳細
ZSHRC_DIR=${${(%):-%N}:A:h}
# source command override technique
function source {
ensure_zcompiled $1
builtin source $1
}
function ensure_zcompiled {
local compiled="$1.zwc"
if [[ ! -r "$compiled" || "$1" -nt "$compiled" ]]; then
echo "\033[1;36mCompiling\033[m $1"
zcompile $1
fi
}
ensure_zcompiled ~/.zshrc
eval "$(sheldon source)"
source $ZSHRC_DIR/nonlazy.zsh
zsh-defer source $ZSHRC_DIR/lazy.zsh
zsh-defer unfunction source
❯ hyperfine -w 5 -r 50 'zsh -i -c exit'
Benchmark 1: zsh -i -c exit
Time (mean ± σ): 21.6 ms ± 0.6 ms [User: 12.3 ms, System: 9.8 ms]
Range (min … max): 21.0 ms … 23.6 ms 50 runs
平均 21.6 ms
標準偏差 0.6 ms
両テクニックを使用
.zshrcおよびベンチマーク詳細
ZSHRC_DIR=${${(%):-%N}:A:h}
# source command override technique
function source {
ensure_zcompiled $1
builtin source $1
}
function ensure_zcompiled {
local compiled="$1.zwc"
if [[ ! -r "$compiled" || "$1" -nt "$compiled" ]]; then
echo "\033[1;36mCompiling\033[m $1"
zcompile $1
fi
}
ensure_zcompiled ~/.zshrc
# sheldon cache technique
export SHELDON_CONFIG_DIR="$ZSHRC_DIR/sheldon"
sheldon_cache="$SHELDON_CONFIG_DIR/sheldon.zsh"
sheldon_toml="$SHELDON_CONFIG_DIR/plugins.toml"
if [[ ! -r "$sheldon_cache" || "$sheldon_toml" -nt "$sheldon_cache" ]]; then
sheldon source > $sheldon_cache
fi
source "$sheldon_cache"
unset sheldon_cache sheldon_toml
source $ZSHRC_DIR/nonlazy.zsh
zsh-defer source $ZSHRC_DIR/lazy.zsh
zsh-defer unfunction source
❯ hyperfine -w 5 -r 50 'zsh -i -c exit'
Benchmark 1: zsh -i -c exit
Time (mean ± σ): 14.6 ms ± 0.3 ms [User: 8.4 ms, System: 6.9 ms]
Range (min … max): 14.2 ms … 16.0 ms 50 runs
平均 14.6 ms
標準偏差 0.3 ms
まとめのようなもの
今回の記事を書くにあたって、私自身かなり勉強になりました。記事を書いていると記事の範囲に限らず次々と改善点が浮かび、執筆前後でzshrcはかなり変化しました。
私の環境はもともとsheldonとzsh-deferによる遅延ロードを使用しており十分に高速でした。しかし今回、両テクニックを使用することでそれ以外を同じ構成とした状態で20ms以上高速化し、15ms前後での起動に成功しています。
ぜひ試してみてください。
Discussion