mix xref command-style (#4808)

Signed-off-by: José Valim <[email protected]>

Author: ericentin

lib/mix/lib/mix/tasks/compile.xref.ex

@@ -36,7 +36,7 @@ defmodule Mix.Tasks.Compile.Xref do
   end
 
   defp run_xref do
-    Mix.Task.run("xref", ["--warnings"])
+    Mix.Task.run("xref", ["warnings"])
   end
 
   defp needs_xref?(opts) do

lib/mix/lib/mix/tasks/xref.ex

@@ -12,12 +12,12 @@ defmodule Mix.Tasks.Xref do
 
   ## Xref modes
 
-  The following options control the information xref can emit.
+  The following commands are available:
 
-    * `--warnings` - prints warnings for violated cross reference checks
-    * `--unreachable` - prints all unreachable "file:line: module.function/arity" entries
-    * `--callers` - prints all references of given `Module`, `Module.function`, or
-      `Module.function/arity`
+    * `warnings` - prints warnings for violated cross reference checks
+    * `unreachable` - prints all unreachable "file:line: module.function/arity" entries
+    * `callers CALLEE` - prints all references of `CALLEE`, which can be one of: `Module`,
+      `Module.function`, or `Module.function/arity`
 
   ## Command line options
 
@@ -36,31 +36,29 @@ defmodule Mix.Tasks.Xref do
   """
 
   @switches [compile: :boolean, deps_check: :boolean, archives_check: :boolean,
-             warnings: :boolean, unreachable: :boolean, elixir_version_check: :boolean,
-             callers: :string]
+             elixir_version_check: :boolean]
 
   @doc """
   Runs this task.
   """
   @spec run(OptionParser.argv) :: :ok | :error
   def run(args) do
-    {opts, _} =
+    {opts, args} =
       OptionParser.parse!(args, strict: @switches)
 
     if Keyword.get(opts, :compile, true) do
       Mix.Task.run("compile")
     end
 
-    modes = [:warnings, :unreachable, :callers]
-    case Keyword.take(opts, modes) do
-      [warnings: true] ->
+    case args do
+      ["warnings"] ->
         warnings()
-      [unreachable: true] ->
+      ["unreachable"] ->
         unreachable()
-      [callers: callee] ->
+      ["callers", callee] ->
         callers(callee)
       _ ->
-        Mix.raise "xref expects exactly one of the following modes: --warnings, --unreachable, --callers"
+        Mix.raise "xref expects one of the following commands: warnings, unreachable, callers CALLEE"
     end
   end
 
@@ -279,7 +277,7 @@ defmodule Mix.Tasks.Xref do
 
   defp raise_invalid_callee(callee) do
     message =
-      "xref --callers expects Module, Module.function, or Module.function/arity, got: " <>
+      "xref callers CALLEE expects Module, Module.function, or Module.function/arity, got: " <>
       callee
 
     Mix.raise message

lib/mix/test/mix/tasks/xref_test.exs

@@ -241,7 +241,7 @@ defmodule Mix.Tasks.XrefTest do
       File.write!("lib/a.ex", contents)
 
       assert capture_io(:stderr, fn ->
-        assert Mix.Task.run("xref", ["--warnings"]) == :error
+        assert Mix.Task.run("xref", ["warnings"]) == :error
       end) == expected
     end
   end
@@ -251,7 +251,7 @@ defmodule Mix.Tasks.XrefTest do
       File.write!("lib/a.ex", contents)
 
       assert capture_io(:stderr, fn ->
-        assert Mix.Task.run("xref", ["--warnings"]) == :ok
+        assert Mix.Task.run("xref", ["warnings"]) == :ok
       end) == ""
     end
   end
@@ -274,7 +274,7 @@ defmodule Mix.Tasks.XrefTest do
       File.write!("lib/a.ex", contents)
 
       assert capture_io(fn ->
-        assert Mix.Task.run("xref", ["--unreachable"]) == :error
+        assert Mix.Task.run("xref", ["unreachable"]) == :error
       end) == expected
     end
   end
@@ -420,34 +420,32 @@ defmodule Mix.Tasks.XrefTest do
 
   test "callers: no argument gives error" do
     in_fixture "no_mixfile", fn ->
-      message =
-        "Could not invoke task \"xref\": 1 error found!\n" <>
-        "--callers : Missing argument of type string"
+      message = "xref expects one of the following commands: warnings, unreachable, callers CALLEE"
 
       assert_raise Mix.Error, message, fn ->
-        assert Mix.Task.run("xref", ["--callers"]) == :error
+        assert Mix.Task.run("xref", ["callers"]) == :error
       end
     end
   end
 
   test "callers: gives nice error for quotable but invalid callers spec" do
     in_fixture "no_mixfile", fn ->
       message =
-        "xref --callers expects Module, Module.function, or Module.function/arity, got: Module.func(arg)"
+        "xref callers CALLEE expects Module, Module.function, or Module.function/arity, got: Module.func(arg)"
 
       assert_raise Mix.Error, message, fn ->
-        Mix.Task.run("xref", ["--callers", "Module.func(arg)"])
+        Mix.Task.run("xref", ["callers", "Module.func(arg)"])
       end
     end
   end
 
   test "callers: gives nice error for unquotable callers spec" do
     in_fixture "no_mixfile", fn ->
       message =
-        "xref --callers expects Module, Module.function, or Module.function/arity, got: %"
+        "xref callers CALLEE expects Module, Module.function, or Module.function/arity, got: %"
 
       assert_raise Mix.Error, message, fn ->
-        Mix.Task.run("xref", ["--callers", "%"])
+        Mix.Task.run("xref", ["callers", "%"])
       end
     end
   end
@@ -458,7 +456,7 @@ defmodule Mix.Tasks.XrefTest do
       File.write!("lib/b.ex", contents_b)
 
       assert capture_io(fn ->
-        assert Mix.Task.run("xref", ["--callers", callee]) == :ok
+        assert Mix.Task.run("xref", ["callers", callee]) == :ok
       end) == expected
     end
   end