diff options
author | omarkj <omarkj@gmail.com> | 2014-11-03 13:58:58 -0800 |
---|---|---|
committer | omarkj <omarkj@gmail.com> | 2014-11-03 13:58:58 -0800 |
commit | a1d030c9649526422f58e0fb5dae9d33564b395a (patch) | |
tree | feb95f0fec3421ed876e1802584430e18e29f73f /src/rebar_prv_help.erl | |
parent | 58f4019fa62a73e335967870f6605182d7386830 (diff) | |
parent | a3ec3a3424dd47e9687d0d2960ef2d3cba6a8f5c (diff) |
add help
Diffstat (limited to 'src/rebar_prv_help.erl')
-rw-r--r-- | src/rebar_prv_help.erl | 50 |
1 files changed, 35 insertions, 15 deletions
diff --git a/src/rebar_prv_help.erl b/src/rebar_prv_help.erl index a9949e7..8300378 100644 --- a/src/rebar_prv_help.erl +++ b/src/rebar_prv_help.erl @@ -3,10 +3,11 @@ -module(rebar_prv_help). --behaviour(rebar_provider). +-behaviour(provider). -export([init/1, - do/1]). + do/1, + format_error/2]). -include("rebar.hrl"). @@ -19,30 +20,49 @@ -spec init(rebar_state:t()) -> {ok, rebar_state:t()}. init(State) -> - State1 = rebar_state:add_provider(State, #provider{name = ?PROVIDER, - provider_impl = ?MODULE, - bare = false, - deps = ?DEPS, - example = "rebar help <task>", - short_desc = "Display a list of tasks or help for a given task or subtask.", - desc = "", - opts = []}), + State1 = rebar_state:add_provider(State, providers:create([{name, ?PROVIDER}, + {module, ?MODULE}, + {bare, false}, + {deps, ?DEPS}, + {example, "rebar help <task>"}, + {short_desc, "Display a list of tasks or help for a given task or subtask."}, + {desc, "Display a list of tasks or help for a given task or subtask."}, + {opts, [ + {help_task, undefined, undefined, string, "Task to print help for."} + ]}])), {ok, State1}. --spec do(rebar_state:t()) -> {ok, rebar_state:t()} | relx:error(). +-spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}. do(State) -> - help(State), - {ok, State}. + {Args, _} = rebar_state:command_parsed_args(State), + case proplists:get_value(help_task, Args, undefined) of + undefined -> + help(State), + {ok, State}; + Name -> + Providers = rebar_state:providers(State), + case providers:get_provider(list_to_atom(Name), Providers) of + not_found -> + {error, io_lib:format("Unknown task ~s", [Name])}; + Provider -> + providers:help(Provider), + {ok, State} + end + end. + +-spec format_error(any(), rebar_state:t()) -> {iolist(), rebar_state:t()}. +format_error(Reason, State) -> + {io_lib:format("~p", [Reason]), State}. %% %% print help/usage string %% help(State) -> ?CONSOLE("Rebar is a tool for working with Erlang projects.~n~n", []), - OptSpecList = rebar3:option_spec_list(), + OptSpecList = rebar3:global_option_spec_list(), getopt:usage(OptSpecList, "rebar", "", []), ?CONSOLE("~nSeveral tasks are available:~n", []), - rebar_provider:help(State), + providers:help(rebar_state:providers(State)), ?CONSOLE("~nRun 'rebar help <TASK>' for details.~n~n", []). |