2020年の Makefile

開発環境の立ち上げやテスト、フォーマットといったコマンド処理を自動化したいとき、どういった方法を考えますか？ 多くの方がシェルスクリプトを挙げると思います。プロジェクトによっては node run とかかもしれません。

ただ、複数種のプロジェクトに携わる場合には極力その方法は似通っていた方が何かと楽ですし、 ちょっとした環境差分を埋めるためにオプションを足したいのだけど、えーっと引数のパースってどうするんだっけ…なんて覚えはありませんか？

そこでお勧めしたいのが make です。

make の歴史

make は元々は C言語などのソースコードをビルドするために生まれたツールです。 ですが、最近では半ばタスクランナー的な用途（※1）に make を用いることがあります。

年を追うごとに本来の用途としての出番が減る（※2）一方で、2012年ごろから私の周囲ではタスクランナー的に使う人がちらほら見られはじめ、 Go言語圏で流行ったこともあり2015年ごろから世間的にも認知されるようになった気がします。

Makefile とは

タスクランナー的な make の用途には、本来のビルドツールとしての使い方の知識はほとんど必要ありません。 make が実行する内容を指定する Makefile は、このような「ルール（Rule）」で構成されます。

target ... : prerequisites ...
	command
	...

target は通常はファイルの名称ですが、install のように動作を表すこともあります。適当な名前をつけられるわけです（※3）。

prerequisites はターゲットを作るときの入力として用いられる「必要条件（Prerequisites）」です。今回は使わないので一旦忘れましょう。

command は echo ... や cat ... | sed ... などのコマンドです（※4）。

target と command を持つ簡単な Makefile を書いてみます。

hello:
	echo "hello, weird"
	pwd

この Makefile があるディレクトリで make hello を実行すると、command の内容とそれらの実行結果が出力されます。

$ ls Makefile
Makefile

$ make hello
echo "hello, weird"
hello, weird
pwd
/Users/tamakiii/Sites/voyagegroup/make-advent-calendar-2020/example/001

make は command に特別な指定をしない限り command も出力します。これは不便なように思われるかもしれませんが、 Makefile の記述量が増えた際、何を実行しているのかが一目瞭然で、その利点の方が遥かに勝ります。

ルールの書き方がわかりました。 あとは自動化したい処理を思うように書くだけです。例えばこんな感じです。

• Go言語のプログラムを build して test する
• npm パッケージを install して clean する
• 開発環境用の設定ファイルを setup する
• プロビジョニングツールとして使う（apt-get install -y ...）

こういった手順を Makefile として書いてやれば、他のマシン上でも同様の手順が再現できます。 開発環境上で実行している多少複雑なテスト手順を、CI で同じように実行する、などなど。便利ですね。

実装の種別とインストール

make は歴史が長いだけあっていくつか実装が存在します。主な実装に「GNU make」「BSD make」「System V make」があります。 ちなみに CMake は Java と JavaScript くらい別物です。

それぞれ細かな差があり、同じ Makefile でも同様に動かないことがほとんどです。入手のしやすさなどから GNU make が多く使われていて、BSD系[?] の macOS ですら GNU make が標準でインストールされていることから、 タスクランナー的な用途の文脈では make は GNU make のことを指します。

macOS では標準でインストールされているものを使うか Home brew 経由で、Linux では各ディストリビューションのパッケージマネージャ経由で、Windows では Make for Windows や MinGW からインストールできます。ただ、Windows は現代では WSL2 の環境を整えた方がよさそうです。

リンク

• https://github.com/voyagegroup/make-advent-calendar-2020/blob/master/example/001
• Golang: Don’t afraid of makefiles - Radomir Sohlich

※1. Phony Target を多様したり、プログラムをビルドする以外の目的で Makefile を書くといった用途。「ベターシェルスクリプト」「実行可能なドキュメント」「読める実行ファイル」「メタ的な Makefile」などの形容がありますが未だになんと呼んだらいいのか個人的に決めかねています。なんて呼んだらいいんですかね

※2. Google Trend 調べ。make は今でもさまざまなオープンソースプロジェクトで使われていて、Autotools や Automake などの知識があると探索がはかどります

※3. このようなターゲットは 「偽のターゲット（Phony Target）」と呼ばれ、.PHONY: で指定されますが、ここでは一旦忘れましょう。

※4. 通常、/bin/sh がデフォルトシェルとして設定されているはずです。