Figを使ってmakeコマンドの説明を出すのが便利だった

はじめに

makeコマンドは便利なのですが、たくさん作ると何がどのコマンドなのか忘れがちでいちいちmakefile見に行くの億劫に感じたことないですか？
僕は開発中に感じていて、偶然Figを使用していてその解決法を発見してかなり快適になったので公開します。

実現したいこと

• makeコマンドを使って、簡単にコマンドを叩けるようにしておく際に、あれこのmakeコマンドなんだっけ？みたいなことになったので、makefileのそれぞれ用意したコマンドを使用する際に説明が見れるようにしたい。

前提(準備)

• Figのインストール
  • Figの使い方は今回説明しません
• makefileにコマンドを用意していること

使い方

• makeファイルにコマンドを用意してコメントを入れて、Figを使えば補完が出てくるので一緒にコメントアウトで説明が表示されます。

Makefile

# frontコンテナのnpmパッケージをアップデート
.PHONY: npm_update_for_front
npm_update_for_front:
	docker-compose exec -T front npm update

# コンテナ起動
.PHONY: up
up:
	docker-compose up -d

# コンテナ停止
.PHONY: down
down:
	docker-compose down

# コンテナビルド
.PHONY: build
build:
	docker-compose build

//...(略)

デモ

終わりに

Fig最高ですね！