Fix ExDoc.CLI.main/2 to keep --source-ref (#680)

Author: eksperimental

lib/ex_doc.ex

@@ -37,13 +37,13 @@ defmodule ExDoc do
        deps: [{ebin_path :: String.t, doc_url :: String.t}],
        extra_section: nil | String.t,
        extras: list(),
-       filter_prefix: String.t | nil,
-       formatter: String.t,
-       formatter_opts: list(),
+       filter_prefix: nil | String.t,
+       formatter: nil | String.t,
+       formatter_opts: Keyword.t,
        homepage_url: nil | String.t,
        logo: nil | Path.t,
        main: nil | String.t,
-       output: Path.t,
+       output: nil | Path.t,
        project: nil | String.t,
        retriever: :atom,
        source_beam: nil | String.t,

lib/ex_doc/cli.ex

@@ -8,12 +8,31 @@ defmodule ExDoc.CLI do
   transform the Markdown documents into a specified format (default is HTML).
   """
   def main(args, generator \\ &ExDoc.generate_docs/3) do
-    {opts, args, _} = OptionParser.parse(args,
-               aliases: [o: :output, f: :formatter, c: :config, r: :source_root,
-                         u: :source_url, m: :main, p: :homepage_url, l: :logo,
-                         e: :extra, v: :version, n: :canonical, s: :extra_section,
-                         a: :assets, i: :filter_prefix],
-               switches: [extra: :keep])
+    {opts, args, _invalid} =
+      OptionParser.parse(args,
+        aliases: [
+          c: :config,
+          o: :output,
+          f: :formatter,
+          i: :filter_prefix,
+          r: :source_root,
+          u: :source_url,
+          m: :main,
+          p: :homepage_url,
+          e: :extra,
+          s: :extra_section,
+          a: :assets,
+          l: :logo,
+          n: :canonical,
+          v: :version,
+        ],
+
+        switches: [
+          extra: :keep,
+          source_ref: :string,
+          version: :boolean,
+        ],
+      )
 
     if List.keymember?(opts, :version, 0) do
       print_version()
@@ -34,7 +53,6 @@ defmodule ExDoc.CLI do
       opts
       |> Keyword.put(:source_beam, source_beam)
       |> merge_config()
-
     generator.(project, version, opts)
   end
 

test/ex_doc/cli_test.exs

@@ -65,4 +65,55 @@ defmodule ExDoc.CLITest do
 
     assert catch_exit(capture_io(fun)) == {:shutdown, 1}
   end
+
+  test "arguments that are not aliased" do
+    File.write!("not_aliased.config", ~s([extra: "README2.md"]))
+
+    args = [
+        "ExDoc", "1.2.3", "ebin",
+        "--config", "not_aliased.config",
+        "--output", "html",
+        "--formatter", "html",
+        "--filter-prefix", "prefix_",
+        "--source-root", "./",
+        "--source-url", "http://example.com/username/project",
+        "--source-ref", "abcdefg",
+        "--main", "Main",
+        "--homepage-url", "http://example.com",
+        "--extra", "README.md", "--extra", "Foo", "--extra", "Bar",
+        "--extra-section", "Extra",
+        "--assets", "foo.css",
+        "--logo", "logo.png",
+        "--canonical", "http://example.com/project",
+
+        # invalid options
+        "--nonexistant",
+        "--non_existant",
+        "--idontexist", "baz",
+        "--i_dont_exist", "baz",
+      ]
+
+    {project, version, opts} = run(args)
+    assert project == "ExDoc"
+    assert version == "1.2.3"
+    assert Enum.sort(opts) == [
+      assets: "foo.css",
+      canonical: "http://example.com/project",
+      extra_section: "Extra",
+      extras: ["README.md", "Foo", "Bar"],
+      filter_prefix: "prefix_",
+      formatter: "html",
+      formatter_opts: [extra: "README2.md"],
+      homepage_url: "http://example.com",
+      logo: "logo.png",
+      main: "Main",
+      output: "html",
+      source_beam: "ebin",
+      source_ref: "abcdefg",
+      source_root: "./",
+      source_url: "http://example.com/username/project",
+    ]
+  after
+    File.rm!("not_aliased.config")
+  end
 end