defmodule Mix.Tasks.Compile.Apidoc do use Mix.Task @moduledoc File.read!("README.md") @shortdoc "Create documentation for RESTful web APIs" @default_node_bin "node" @default_apidoc_bin Path.join(~w"node_modules apidoc bin apidoc") @default_input_dir Path.join(~w"web controllers") @default_output_dir Path.join(~w"priv static apidoc") @doc false def run(_) do config = Mix.Project.config[:apidoc] unless config do Mix.raise "Please specify an apidoc config in your mix.exs" end node_bin = config[:node_bin] || @default_node_bin apidoc_bin = config[:apidoc_bin] || Path.join(System.cwd(), @default_apidoc_bin) input_dir = config[:input_dir] || @default_input_dir output_dir = config[:output_dir] || @default_output_dir extra_args = config[:extra_args] || [] config_json = config |> Enum.into(%{}) |> Map.drop(~w(node_bin apidoc_bin input_dir output_dir extra_args)a) |> Poison.encode! build_dir = Mix.Project.build_path File.mkdir_p! build_dir apidoc_json = build_dir |> Path.join("apidoc.json") |> File.open!([:write, :utf8]) IO.write apidoc_json, config_json File.close apidoc_json params = ["-i", input_dir, "-o", output_dir, "-c", build_dir] ++ extra_args run_apidoc(node_bin, apidoc_bin, params) end defp run_apidoc(node_bin, apidoc_bin, params) do if File.exists?(apidoc_bin) do exec_apidoc(node_bin, apidoc_bin, params) else apidoc_global = System.find_executable(apidoc_bin) if apidoc_global |> is_nil do Mix.raise "Could not find apidoc executable '#{apidoc_bin}'. " <> "Run 'npm install' or set the 'apidoc_bin' config parameter " <> "in your 'mix.exs' to a different apidoc executable." else exec_apidoc(node_bin, apidoc_global, params) end end end defp exec_apidoc(node_bin, apidoc_bin, params) do node_bin |> System.cmd([apidoc_bin | params]) |> _handle_result end defp _handle_result({_, 0}), do: Mix.Shell.IO.info "Generated apidoc" defp _handle_result(_error), do: Mix.raise "apidoc responded with an error" end