コンテンツにスキップ

Taskfileの使い方

シンプルなタスクランナーのTaskfileについて使い方を解説する。

インストール方法

homebrewがインストール済みの場合は以下のコマンドでインストールできる。

Bash
brew install go-task

初期化

タスクを実行したいディレクトリで以下のコマンドを実行する。

Bash
task -i

Taskfile.ymlが生成されるので、これ以降はこのファイルを編集する。

タスクの登録

生成されたファイルは以下のようになっている。

Text Only
# https://taskfile.dev

version: '3'

vars:
  GREETING: Hello, World!

tasks:
  default:
    cmds:
      - echo "{{.GREETING}}"
    silent: true

defaultは実行する際の名前である。 cmdsは複数のコマンドを記載可能である。 以下のコマンドを実行するとHello, World!が出力される。

Bash
task default

{{.GREETING}}は変数部分で、コマンド実行時に上書きができる。以下のコマンドを実行するとHeyが出力される。

Bash
task default GREETING=Hey

silentfalseにすると実行したコマンドが表示される。 また、記載しないとfalseと同じ結果になる。

グローバルタスクファイルの作成

自分がどのディレクトリにいても実行できるグローバルタスクの設定について説明する。

まずは自分のホームディレクトリでTaskfile.ymlを作成する。 ただし、それだけだと実行時ディレクトリがホームディレクトリになってしまうので、実行したディレクトリに設定する必要がある。

Text Only
1
2
3
tasks:
  タスク名:
    dir: '{{.USER_WORKING_DIR}}'

参考