カスタムMixタスク

導入

カスタムのMixタスクを追加してElixirアプリケーションの機能を拡張したいと思うのは珍しいことではありません。 私たちのプロジェクト特有のMixタスクを作成する方法を学ぶ前に、既存のタスクを見てみましょう:

$ mix phx.new my_phoenix_app

* creating my_phoenix_app/config/config.exs
* creating my_phoenix_app/config/dev.exs
* creating my_phoenix_app/config/prod.exs
* creating my_phoenix_app/config/prod.secret.exs
* creating my_phoenix_app/config/test.exs
* creating my_phoenix_app/lib/my_phoenix_app.ex
* creating my_phoenix_app/lib/my_phoenix_app/endpoint.ex
* creating my_phoenix_app/test/views/error_view_test.exs
...

上のシェルコマンドから分かる通り、Phoenix Frameworkは新しいプロジェクトを作成するカスタムのMixタスクを持っています。 私たちのプロジェクトのために、同様のものを作るにはどうすればいいでしょうか？幸いなことに、カスタムMixタスクの作成が可能であるだけでなく、Elixirはそれをとても簡単にしてくれます。

セットアップ

基本的なMixアプリケーションをセットアップしましょう。

$ mix new hello

* creating README.md
* creating .formatter.exs
* creating .gitignore
* creating mix.exs
* creating lib
* creating lib/hello.ex
* creating test
* creating test/test_helper.exs
* creating test/hello_test.exs

Your Mix project was created successfully.
You can use "mix" to compile it, test it, and more:

cd hello
mix test

Run "mix help" for more commands.

それでは、Mixが生成した lib/hello.ex に、 “Hello, World!” を出力する簡単な関数を作成しましょう。

defmodule Hello do
  @doc """
  Outputs `Hello, World!` every time.
  """
  def say do
    IO.puts("Hello, World!")
  end
end

カスタムMixタスク

カスタムのMixタスクを作成しましょう。 新しいディレクトリとファイル、 hello/lib/mix/tasks/hello.ex を作成してください。 このファイルに以下の7行のElixirコードを追加しましょう。

defmodule Mix.Tasks.Hello do
  @moduledoc "The hello mix task: `mix help hello`"
  use Mix.Task

  @shortdoc "Simply calls the Hello.say/0 function."
  def run(_) do
    # calling our Hello.say() function from earlier
    Hello.say()
  end
end

defmodule文が Mix.Tasks と、そしてコマンドラインから呼び出したい名前から始まっているのに気付いてください。 二行目では、名前空間に Mix.Task ビヘイビアをもたらす use Mix.Task を実行しています。 それから、今のところ全ての引数を無視するrun関数を宣言します。 この関数の中では、 Hello モジュールの say 関数を呼び出しています。

アプリケーションの読み込み

多くのMixタスクのユースケースでは問題ありませんが、Mixはアプリケーションやその依存関係を自動的に起動しません。しかしEctoを使用してデータベースとやり取りする必要がある場合はどうでしょうか？その場合、Ecto.Repoの起動を確認する必要があります。これを処理する方法は2つあります。明示的にアプリを起動する方法と、アプリケーションを起動して他のアプリ達も起動する方法です。

Mixタスクを更新してアプリケーションと依存関係を開始する方法を見てみましょう。

defmodule Mix.Tasks.Hello do
  @moduledoc "The hello mix task: `mix help hello`"
  use Mix.Task

  @shortdoc "Simply calls the Hello.say/0 function."
  def run(_) do
    # This will start our application
    Mix.Task.run("app.start")

    Hello.say()
  end
end

Mixタスクの実行

私たちのMixタスクを確かめてみましょう。 アプリケーションのディレクトリにいる限り、これは上手くいきます。 コマンドラインから mix hello を実行すると以下のようになるはずです:

$ mix hello
Hello, World!

Mixはデフォルトでかなり親切です。 誰もが時々スペルミスをするのを知っているので、ファジーマッチングと呼ばれる技術を用いて候補を提案します:

$ mix hell
** (Mix) The task "hell" could not be found. Did you mean "hello"?

また、前に新しいモジュール属性である @shortdoc を紹介したのに気がついたでしょうか？これは mix help コマンドをターミナルで実行したときのように私たちのアプリケーションを使用するときに便利です。

$ mix help

mix app.start         # Starts all registered apps
...
mix hello             # Simply calls the Hello.say/0 function.
...

注: 新しいタスクが mix help の出力に表示されるには、コードが事前にコンパイルされてなければいけません。 mix compile を直接実行するか、先ほどと同じように mix hello を実行してコンパイルのトリガーを作り出すことでコンパイルできます。

間違いを報告したい、あるいはこのレッスンに貢献したい？ このレッスンをGitHubで編集しよう！