Add extra_success_returns config

Fixes #118

Author: qgadrian

README.md

@@ -197,6 +197,25 @@ config :git_hooks,
   ]
 ```
 
+By default this library expects by default the following return values from mix tasks:
+
+```elixir
+0
+:ok
+nil
+```
+
+If you want to support additional success return values from your mix tasks, you
+can add them by adding the following configuration:
+
+```elixir
+config :git_hooks,
+  extra_sucess_returns: [
+    {:noop, []},
+    {:ok, []}
+  ]
+```
+
 #### Command
 
 To run a simple command you can either declare a string or a tuple with the

lib/config.ex

@@ -63,6 +63,17 @@ defmodule GitHooks.Config do
     Application.get_env(:git_hooks, :mix_path, "mix")
   end
 
+  @doc """
+  Returns the configuration for additional success returns from mix
+  tasks.
+
+  See `GitHooks.Task` for default supported returns from Mix task.
+  """
+  @spec extra_sucess_returns() :: list(term)
+  def extra_sucess_returns do
+    Application.get_env(:git_hooks, :extra_sucess_returns, [])
+  end
+
   defdelegate tasks(git_hook_type), to: TasksConfig
 
   defdelegate verbose?, to: VerboseConfig

lib/git_hooks.ex

@@ -7,6 +7,9 @@ defmodule GitHooks do
     Install.run(["--quiet"])
   end
 
+  @typedoc """
+  A Git hook
+  """
   @type git_hook_type :: atom
   @type git_hook_args :: list(String.t())
 

lib/tasks/mix.ex

@@ -56,6 +56,13 @@ defimpl GitHooks.Task, for: GitHooks.Tasks.Mix do
   alias GitHooks.Tasks.Mix, as: MixTask
   alias GitHooks.Printer
 
+  # Mix tasks raise an error if they are valid, but determining if they are
+  # success or not depends on the return of the task.
+  # @default_success_results [0, :ok, nil, {:ok, []}, {:noop, []}]
+  @default_success_results [0, :ok, nil]
+
+  @sucess_results GitHooks.Config.extra_sucess_returns() ++ @default_success_results
+
   def run(%MixTask{task: :test, args: args} = mix_task, _opts) do
     args = ["test" | args] ++ ["--color"]
 
@@ -75,22 +82,17 @@ defimpl GitHooks.Task, for: GitHooks.Tasks.Mix do
     Map.put(mix_task, :result, result)
   end
 
-  # Mix tasks raise an error if they are valid, but determining if they are
-  # success or not depends on the return of the task.
-  @success_results [0, :ok, nil]
-
-  def success?(%MixTask{result: result}) when result in @success_results, do: true
-  def success?(%MixTask{result: _}), do: false
-
-  def print_result(%MixTask{task: task, result: result} = mix_task)
-      when result in @success_results do
-    Printer.success("`#{task}` was successful")
-
-    mix_task
-  end
+  def success?(%MixTask{result: result}) when result in @sucess_results, do: true
+  def success?(%MixTask{result: _result}), do: false
 
   def print_result(%MixTask{task: task, result: result} = mix_task) do
-    Printer.error("mix task `#{task}` failed, return result: #{inspect(result)}")
+    case result do
+      result when result in @sucess_results ->
+        Printer.success("`#{task}` was successful")
+
+      _ ->
+        Printer.error("mix task `#{task}` failed, return result: #{inspect(result)}")
+    end
 
     mix_task
   end