🚀

Not `make` do it, `just` do it!

2023/11/07に公開

makefile

justfile

tech

TL;DR

Makefileは「ビルドするタスク」を記述するためのもの
ビルドしないタスクも記述できるが, makeだとちょっと残念な点がある
ただのタスクを記述するだけならmakeよりもjustを使ってみるといいかもしれない

`make` It!

makeはプログラムやソフトウェアをビルドするコマンド/ツールです. ^[1]
Makefileに記述された, ターゲットに関するレシピを実行することで, プログラムやソフトウェアのビルドやテスト, デプロイなどを行います.
これを利用することで, 実行しなければならないコマンド群を記録しておき, 依存関係に従って 1 コマンドで必要な処理を実行できます.

hello: hello.cpp
	g++ -o hello hello.cpp

hello.cpp:
	echo '#include<iostream>' >> hello.cpp
	echo 'using namespace std;' >> hello.cpp
	echo 'int main() { cout << "Hello World!" << endl; return 0;}' >> hello.cpp

.PHONY: clean
clean:
	rm -f hello hello.cpp

上記記述の場合, helloターゲットはhello.cppに依存しており, hello.cppのビルドを先に実行しなくてはならないことを示しています.

make hello
# echo '#include<iostream>' >> hello.cpp
# echo 'using namespace std;' >> hello.cpp
# echo 'int main() { cout << "Hello World!" << endl; return 0;}' >> hello.cpp
# g++ -o hello hello.cpp

無事にhelloターゲットのビルドが完了し, 実行可能バイナリの生成が行われました.

./hello
# Hello World!

不要になったバイナリや生成されたソースコードを削除する場合は, cleanターゲットを実行します.

make clean
# rm -f hello hello.cpp

今回注目したいのは最後の「何も生成せず, 記述されたタスクのみを実行した」という仮想(PHONY)ターゲットcleanです.

`make` Do It...?

Makefileには「実際に何もビルドしないターゲット」を定義できます.
これに着目し, 「コマンドがクソ長くて覚えるのもダルいし一発でできたほうがカッコいいしもうMakefileで書いちゃおうぜ」としている派閥があります. (諸説あり)

良い例がdocker composeです.

services:
  app:
    image: nginx:latest
# その他有象無象のコンテナたち...

up:
	docker compose up -d

down:
	docker compose down

console:
	docker compose exec app bash

.PHONY: up down console

これにより劇的にコマンドが短縮されました.

make up
# docker compose up -d

make down
# docker compose down

make console
# docker compose exec app bash

上記例は単発コマンドのみですが, 複数のコンテナにまたがった初期化処理を行わなければならないといった場合には短縮量はかなりのものになります.

init:
	docker compose exec app bundle install
	docker compose exec app yarn install
	docker compose exec app bundle exec rails db:create db:migrate db:seed

make init

残念ポイント

この方法で利用する場合, Makefileは便利なツールですが, いくつか残念な点があります.

PHONY

Makefileは「ビルドするもの」を記述するためのものです.
何もビルドしないタスク実行用途では仮想ターゲットであることを明示するため.PHONYを記述する必要があります.

.PHONY: up down console

この指定を忘れてしまった場合, 該当するターゲットと同一の名称のファイルまたはディレクトリが存在すると, 該当のタスクが実行できなくなります.
これはターゲットに依存しているファイルが存在せず, 更新すべきタイミングをmakeが識別できないことに起因するものです.
依存関係がないものは, 一度作成してしまえばそれ以後は再作成する必要がないものとみなされます.

touch console

make console
# make: 'console' is up to date.

Arguments

Makefileでは, コマンドライン引数を利用するためには, 変数として値を格納して実行する必要があります.
例えば前述のmake upの例で, 特定のコンテナのみ起動したい場合には, 以下のように記述する必要があります.

up:
	docker compose up -d $(CONTAINER)

make up CONTAINER=app

うっかり docker compose up -d appを打つんだ!!と変数に格納するのを忘れると, 別のターゲットが実行されることになります.

make up app
# make: *** No rule to make target 'app'.  Stop.

渡したい引数が 1 つならこれで問題ありませんが, 複数になってくると記述量は増え, 当初「コマンド入力を短くする」という目標に相反する状態となっていきます.

Indent

Makefileでは, ターゲットに対するレシピの記述は Tab でインデントしなければなりません.

# NG
hello: hello.cpp
        g++ -o hello hello.cpp

# OK
hello: hello.cpp
	g++ -o hello hello.cpp

見た目上かなり分かりづらく, 初学者が「なんか動かなくなったんですけど...」となる 1 つの要因です.
近年のインデント事情を鑑みると.

言語	インデント
Rust	The Rust Style Guide ^[2] にてSpaceのみ利用指定. rustfmtにてSpaceの利用を強制
C++	LLVM^[3]やGoogle^[4]のコーディングスタイルではSpaceのみを利用指定
Python	PEP8^[5]でSpaceを強く推奨
Ruby	Ruby Style Guide^[6]にてSpaceのみを利用指定

といったように, Tab ではなく Space にすることが圧倒的に多くなっています.
エディタの設定を特に行わないまま他のプログラムと同様にMakefileを書くと, 思わぬ罠に引っかかります.
(今この記事を記述している私も, 今 Makefile のコードブロックを書くときだけインデントモードを Tab にしています)

`just` Do It!

そこでコマンドランナー justの登場です.

https://github.com/casey/just

Makefileのような定義ファイルJustfileを作成し, 記述されたレシピに対応する処理を実行できます.

up:
    docker compose up -d

down:
    docker compose down

console:
    docker compose exec app bash

just up
# docker compose up -d

just down
# docker compose down

just console
# docker compose exec app bash

`make` vs `just`

ビルド vs タスク

justはビルドツールではないため, .PHONYの指定は不要です.
レシピ名と同一のファイルやディレクトリがあったとしても, それを無視してレシピに記述された処理を実行します.

touch console

just console
# docker compose exec app bash

依存関係指定はできますが, 依存するレシピの名称を記述する形になります.
特定のファイルの有無による制御はできません.

# レシピ名に"."は含められないので, hello.cppとは記述できない
hello: hello_cpp
        g++ -o hello hello.cpp

hello_cpp:
        echo '#include<iostream>' >> hello.cpp
        echo 'using namespace std;' >> hello.cpp
        echo 'int main() { cout << "Hello World!" << endl; return 0;}' >> hello.cpp

clean:
        rm -f hello hello.cpp

これはmakeの利点の 1 つである「再ビルドしなくても良い物はビルドしない」という制御が欠落することを意味します.

# hello.cpp, hello の binary が作成される
just hello

# 既に存在しているhello.cppに追記, hello の binaryを生成しようとして重複したmain関数でコンパイルエラー
just hello

# (記事冒頭のMakefile前提)
# hello.cpp, hello の binary が作成される
make hello

# 依存している対象が更新されていない場合, 何もしない
make hello

タスクの実行に際してはjustは余計な指定が不要になりますが, ビルドを行って成果物が生じる場合はmakeの方が良いでしょう.

Arguments

justはコマンドライン引数をそのまま利用できます.

up *args:
    docker compose up -d {{ args }}

just up app
# docker compose up -d app

他にもデフォルト値を設定したり.

up *args="app":
    docker compose up -d {{ args }}

just up
# docker compose up -d app

位置引数として展開して複数のコマンドで使ったりもできます.

set positional-arguments

sample a b c:
    echo "a: $1"
    echo "b: $2"
    echo "c: $3"

just sample 3 2 1
# echo "a: $1"
# a: 3
# echo "b: $2"
# b: 2
# echo "c: $3"
# c: 1

この点に関してはjustに軍配が上がります.

Indent

justは Space でも Tab でもインデントを認識します.

# OK
up:
        docker compose up -d
# OK
up:
	docker compose up -d

ややこしい部分が減るのはそれだけで嬉しいものです.

その他

他にもjustにはタスク実行に際して便利な機能がいくつかあります.

各タスクのドキュメント記述とヘルプ表示
- just --listにて, どんなレシピがあるのか, 何をするものなのかを表示できます
実行シェル/言語の指定
- Shell 以外に Python 等も指定可能
.envからの環境変数読み取り
- just打つ前に export しなくちゃ...の手間なし
サブディレクトリからも実行可能
- justを実行したディレクトリから親ディレクトリを探索
変数定義と展開

詳しくはリポジトリのドキュメントを参照ください.

雑感

次のような用途/PJ の場合, 利用検討の余地はありそうです.

個人の手元環境の整備に利用する
- HOME においておけばサブディレクトリから打てるので汎用性が高い
- alias や shell 関数を書くより手間が少なく済む
ビルド対象が存在しない / makeで依存関係管理をそもそも期待していない
タスク一覧表示や dotenv 等の機能が欲しい
タブ文字に破壊衝動を覚えたことがある

これらに当てはまらない場合には素直にmakeを使うほうがおそらく良いです.
また既にMakefileを利用している状態での導入はやめておくべきです.
絶対どっちのコマンドだっけ...となるので.

まとめ

生成物を伴わないタスクであればjustを利用すると, タスクを簡素にかつ便利に記述できます.
逆にビルド処理が必要となるタスクの場合は, 依存関係解決の関係からmakeのほうがまだ利点は多いでしょう.

あなたが書きたかったのは「生成物のビルド処理を実行する」makeか, 「ただタスクを実行する」justか, どちらだったでしょうか?

Not make do it, just do it!

脚注

GitHubで編集を提案

TL;DR

make It!

make Do It...?

残念ポイント

PHONY

Arguments

Indent

just Do It!

make vs just

ビルド vs タスク

Arguments

Indent

その他

雑感

まとめ

Discussion

`make` It!

`make` Do It...?

`just` Do It!

`make` vs `just`