rebar3/priv/templates/plugin.erl.dtl

-module({{name}}).
-behaviour(provider).

-export([init/1, do/1, format_error/2]).

-include_lib("rebar3/include/rebar.hrl").

-define(PROVIDER, todo).
-define(DEPS, [app_discovery]).

%% ===================================================================
%% Public API
%% ===================================================================
-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.
init(State) ->
    Provider = providers:create([
            {name, ?PROVIDER},          % The 'user friendly' name of the task
            {module, ?MODULE},          % The module implementation of the task
            {bare, true},               % The task can be run by the user, always true
            {deps, ?DEPS},              % The list of dependencies
            {example, "rebar {{name}}"}, % How to use the plugin
            {opts, []}                  % list of options understood by the plugin
            {short_desc, "{{desc}}"},
            {desc, ""}
    ]),
    {ok, rebar_state:add_provider(State, Provider)}.


-spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
do(State) ->
    {ok, State}.

-spec format_error(any()) ->  iolist().
format_error(Reason, State) ->
    io_lib:format("~p", [Reason]).