make でナイーブなファイル変更監視とビルド
Makefile を使っているプロジェクトの場合、以下のようにしておくと簡易的なファイル変更監視 & ビルドの仕組みになる。
while true; do make build --silent; sleep 1; done
要は定期的に make コマンドを実行しているだけ。
めちゃくちゃ単純なので、linux 系であればほぼどんな環境でも何もせずに動くのと、見れば何をやっているか一目瞭然なのがメリット。一方で毎秒ポーリングしているので無駄が多いのがデメリットと言えると思う。
Makefile のおさらい
Makefile の基本的なルールの書き方は、
ターゲット (targets): 依存するファイル (prerequisites)
依存からターゲットを生成するためのコマンド (recipe)
ターゲットは呼び出しごとに毎回ビルドされるわけではなく、以下のいずれかの条件にマッチした時にだけビルドされる。
- ターゲットが無い
- またはターゲットよりも依存するファイルの方が新しい
How to decide whether foo.o is out of date: it is out of date if it does not exist, or if either foo.c or defs.h is more recent than it.
こうしたルールを適切に設定しておくと、あとはそれを定期的に呼び出すだけで、簡易的な変更監視&ビルドの仕組みになる。
cou929/please-sleep-2 での例
cou929/please-sleep-2 はこのブログのコンテンツを管理しているリポジトリ。中にはブログのコンテンツとそれを変換するヘルパーツールが入っている。
やりたいことは、ブログのコンテンツを追加したりヘルパーツールを修正した際に、自動でビルド (ヘルパーツールをコンパイルし、それを使ってコンテンツを再生成) してほしいというもの。特にブログ本文は生成した html を見ながら何度も推敲するので、変更検知してくれるとありがたい。
大した処理をしているわけでもないので、特別な仕組みを導入せずにこれを実現したかった。もともと Makefile を使っていたこともあり、今回の方法を採用した。
Makefile は次のようにした。
SRCS := $(shell find . -type f -name '*.go') # ヘルパーツールのソースファイル
POSTS := $(shell find ./post -type f) # ブログコンテンツ
dist: $(POSTS) $(SRCS) # 結果を ｀dist/` に格納する
make clean
make run
make asset
成果物は dist/ ディレクトリに全部突っ込まれる。make に dist と依存ファイルの SRCS, POSTS を見てもらっている。
ついでに watch というコマンドも追加し、make dist ルールを定期的に呼び出すようにした。
.PHONY: watch
watch:
while true; do \
make dist --silent; \
sleep 3; \
done
これで make watch とするだけでやりたいことができた。
この仕組みはまだ使い始めたばかりだが、この程度の規模だと十分実用に耐えられそう。
発展
この方法は make が毎回対象の全ファイルをポーリングするような動きになるので、当然無駄が多い。問題になる場合は、変更があった場合にだけ通知を受ける仕組みにしたい。
今回参考にした記事 では inotify ベースのツール (inotifywait, fswatch) を使う方法が解説されていた。
.PHONY watch
watch:
while true; do \
inotifywait -qr -e modify -e create -e delete -e move app/src; \
make build; \
done
inotify (inode notify) とは、ファイルシステムへの変更を通知するようファイルシステムを拡張して、その変更をアプリケーションに報告するLinuxカーネルサブシステムである。
そもそもがこの手のツールはだいたい inotify に乗っかっているらしい。
参考
- GNU make
- Automatically build files when they change with Make · From An Egg
- inotify - Wikipedia
- inotifywait(1) - Linux man page
- fswatch
