一般的なコーディングタスクのためのタスクランナーの使用
Use Task Runners for Common Coding Tasks (hamvocke.com)
要約
この記事では、異なるコードリポジトリ間での依存関係のインストール、ビルド、コードのリンティングやフォーマット、テスト実行といった共通のコーディングタスクを簡素化するために、タスクランナーを活用する方法を解説しています。bashスクリプト、make、just、miseといったツールを紹介し、これらのツールが開発者の作業効率をどのように向上させるかについて説明しています。
全文翻訳
一般的なコーディングタスクのためのタスクランナーの利用
(Originally published in 2019. I pulled this one from the archives and gave it a fresh makeover after a reader reached out to tell me they misses this article.)
ソフトウェア開発者として日々、私はさまざまなコードリポジトリ間を切り替えています。各リポジトリは異なる技術スタックで書かれている可能性がありますが、それらのスタックに関わらず、私がすべてのリポジトリで実行する必要のある共通タスクがあります。依存関係のインストール、ソースコードのビルド、コードのリント、フォーマット、テストの実行、データベースマイグレーションの実行、ステージング環境へのデプロイ、新しいバージョンの作成、依存サービスの起動など、想像できるでしょう。
各リポジトリで使用されている具体的なツールによっては、コマンドラインから呼び出すための、いくつか扱いにくい呪文を覚えなければなりませんでした。フォーマットするには rust fmt でしたか? 依存関係を更新するには mix deps.update でしたか? ./gradlew build でしたか、それとも mvn に戻ったのでしょうか? 結局のところ yarn なのか npm なのか pnpm なのでしょうか? npm run prettier に引数を渡す必要がありましたか? そして、ゼロからすべてのマイグレーションを実行するための3ステップのコマンドは何でしたか?
私はこれらのことを覚えていたくありません。
私は「コードをビルドして」「リントして」「フォーマットして」「マイグレーションを実行して」「依存関係をインストールして」と言えるようになりたいのです。
私の人生をほんの少しでも楽にするために、私はしばしば、どのリポジトリにいても同じ方法で共通タスクを実行できる便利なツールを作成します。これにより、毎日数十回行う作業にマッスルメモリを適用できるようになります。
これを実現する方法はいくつかあります。昔ながらのBashスクリプトやmakeから、miseやjustのようなよりモダンなツールまであります。これらのツールを「タスクランナー」と呼び始めた人もいるので、ここではその名前を使うことにします。これらの選択肢を一緒に見ていきましょう。
シンプルなBashスクリプト
簡単なシェルスクリプト(または選択したLLMに協力を依頼して)を書いて、コードを操作するために必要な、よく実行されるコマンドの小さなラッパーとして機能させることができます。
以下に例を示します。この例では、node/npm/javascriptを使用していると仮定しています。そうでない場合は、自分で補完できるはずです。
#!/usr/bin/env bash
set -e
function usage {
# print usage information
}
function install {
# install dependencies
npm run ci
}
function build {
# trigger build process
npm run build
}
function test {
# run test suite
# you can even run multiple steps in one command, cool huh?
npm run test:unit
npx run playwright
}
function format {
# it works well for hiding args we need to pass to underlying commands
npm run prettier --write
}
# call the function with the name that was passed to this script - or show
# usage information if nothing was passed
${@:-usage}
そのスクリプトを、リポジトリのルートディレクトリにある好きなファイル名で保存します。短くて分かりやすい名前を選んでください。何度も入力することになります(私はrunを使う傾向があります)。ああ、そしてchmod +x runで実行可能にすることを忘れないでください。
このスクリプトがあれば、run build、run lint、run testのように、プロジェクトに必要な他のコマンドを追加して使用するだけで済みます。
シェルスクリプトを使用する利点は、多くの柔軟性があることです。より複雑なタスクを実行でき、一般的な落とし穴を防ぐための洗練された検証を簡単に追加できます。例えば、誰かが誤ってPRODデータベースを削除するのを避けたい場合などです。
もしBashスクリプトが手に負えなくなったら、上記のスクリプトで概説された個々の関数を専用のシェルスクリプトに抽出し始めることができます。一般的な慣習として、リポジトリのbin/ディレクトリに保存しますが、それは本当にあなた次第です。
Bashは、このような単純な自動化タスクの自然な選択肢です。ほとんどの開発者のマシン(およびCI/CDサーバー)で利用可能であり、非常に柔軟です。その構文が疑問視されなければ、ですが…
Make
makeは、私たちの自由になるもう一つの古典的なツールです。1970年代から続くビルド自動化ツールとして時間の試練に耐え、 pretty much すべての開発者のマシンにインストールされています。
makeを少しだけ変形させて、単純なタスクランナーに変身させ、そのより強力な機能のほとんどを無視することができます。
makeは、現在のディレクトリにあるMakefileというファイルを探して、何をするべきかを判断します。Makefileは、実行できるさまざまなルールを定義するプレーンテキストファイルです。
A rule follows this pattern:
target: dependencies
system command to execute
targetは、コマンドラインからルールをどのように呼び出すかを定義します。make testは、“test”という名前のルールを探し、定義されたコマンドを実行します。
上記のBashスクリプトに匹敵する単純なMakefileは次のようになります。
.PHONY: install build test format
install:
npm run ci
build:
npm run build
test:
npm run test:unit
npx run playwright
format:
npm run prettier --write
Note
makeはインデントにうるさいので注意してください。コマンドはスペースではなくタブでインデントする必要があります。上記のコードスニペットをコピーしても、ファイルが正しくインデントされていることを確認しないと機能しない場合があります。
このMakefileをプロジェクトのルートに配置すると、定義したタスクを実行するために、コマンドラインから単にmake install、make test、またはmake formatを実行できます。
.PHONYターゲットとは?
Makefileの最初の行をよく見ると、.PHONY:で始まる行があります。
.PHONY: install build test format
この行は、3つのターゲットすべてをphonyターゲット、つまりファイルシステム上のファイルを作成または依存しないターゲットとして宣言しています。Stack Overflowのこの回答が、これが何であるかを素晴らしい方法で説明しています。要するに、makeは通常、実行するターゲットの出力としてファイルを作成することを期待しています。これらのファイルが存在する場合、makeは何もしません。
例として、上記のMakefileを見てみましょう。Makefileの隣に“format”という名前のファイルがあり、formatターゲットをphonyターゲットとして宣言しなかった場合、make formatを実行すると、makeは怠惰に何も実行することを拒否します。単に次のように主張します。
make: `format' is up to date.
これはありそうにないかもしれませんが、誰かがformatという名前のファイルを作成する可能性はゼロではありません。その発生時に、ツールが壊れて長い迷走することになるのは避けたいです。そのため、念のためすべてのターゲットを.PHONYとして宣言します。
タブ補完
makeを使用することで得られるもう一つのクールな無料特典は、一部のシェルが、標準で、または小さなユーティリティパッケージをインストールすることで、ターゲットの自動補完を提供することです。zshとfishは、標準で(または最小限の設定で)makeの自動補完をサポートしています。bashを使用している場合は、このパッケージをインストールすることで、makeだけでなく、自動補完を取得できます。
makeの自動補完が有効になると、コマンドラインでmakeと入力し始め、tabキーを繰り返し押すことで、Makefileで定義された利用可能なターゲットを循環できます。 pretty cool ですね?
さらに多くの機能があります
Makeは、単純なタスクランナー以上のものです。ファイルベースのビルドツールとして最も一般的に使用されています。ターゲット間の依存関係を設定したり、関数や変数を宣言したり、さらに多くのことができます。もしそれがあなたが必要とするものであれば、maketutorial.comはあなたにとって素晴らしいリソースです。
Just
justは、この分野の比較的新しいプレイヤーです。Makeから多くのインスピレーションを得ており、タスクランナーに役立ついくつかの素晴らしい機能を追加し、Makeの奇妙な部分(phonyターゲットの宣言が必要なことなど)をいくつか削除しています。
Makeを知っていれば、justは非常に馴染み深いでしょう。リポジトリのルートにjustfileを保存すれば準備完了です。
install:
nnpm run ci
build:
npm run build
test:
npm run test:unit
npx run playwright
format:
npm run prettier --write
小さな欠点は、justが(bashやmakeとは異なり)開発者のマシンで標準で利用できないことです。幸いなことに、多くのパッケージマネージャーで利用できるため、インストールは非常に簡単です。
さらに深く掘り下げたい場合は、公式マニュアルが役立ちます。
Mise
この分野のもう一つの競合はmiseです。近年、miseは開発者のスイスアーミーナイフへと成長しました。執筆時点では、パッケージのインストール、開発ツールの(および特定のバージョンの)管理、環境変数の管理、そしてもちろん、タスクの実行を可能にするツールです。
プロジェクトのルートにmise.tomlファイルを作成し、以下のようなタスクを宣言します。
[tasks.install]
description = "Install dependencies"
run = "npm ci"
[tasks.build]
description = "Build the application"
run = "npm run dev"
[tasks.test]
description = "Run unit and e2e tests"
run = "npm run test:unit && npx run playwright"
[tasks.format]
description = "Format the code"
run = "npm run prettier --write"
単純な単一のmise.tomlファイルを超えてしまう場合は、タスクを独自のタスクファイルに抽出したり、私がBashの例で説明したようなラッパーとして単純なBashスクリプトを使用したりできます。
結論
以上です。複数のリポジトリで共通のコーディングタスクを便利かつ一貫した方法で実行するための複数の方法を紹介しました。これはロケット科学ではありません。あなたとあなたのチームにとって、小さなQOL(Quality of Life)の向上です。セットアップは非常に簡単ですが、それでも実際に目にすることはめったにありません。これは、明日の最初のコーヒーを飲みながら実装できる小さなことの一つであり、その日の善行となるでしょう。