Add mix help Mod, mix help :mod, mix help Mod.fun and mix help Mod.fun/arity

[renanroberto]

Implementing issue #14244

[josevalim]

I believe we can call loadpaths!()instead!

[josevalim]

Instead of a regex, let's use pattern matching!

case task_or_module do
  <<first, _::binary>> when first in ?A..?Z or first == ?: ->

[josevalim]

We need to apply this configuration to IEx as well, so maybe we need something like:

iex_colors = Application.get_env(:iex, :colors, [])

try do
  Application.put_env(:iex, :colors, Application.get_env(:mix, :colors))
  IEx.Introspection.h()
after
  Application.put_env(:iex, :colors, iex_colors)
end

[renanroberto]

Had some progress, but there still a test failing

test "errors when given {file, line} is not available" do
  assert capture_iex("open({~s[foo], 3})") =~
           "Could not open \"foo\", file is not available"
end

1) test open errors when given {file, line} is not available (IEx.HelpersTest)
   lib/iex/test/iex/helpers_test.exs:291
   Assertion with =~ failed
   code:  assert capture_iex("open({~s[foo], 3})") =~ "Could not open \"foo\", file is not available"
   left:  "Invalid arguments for open helper: {{:sigil_s, [delimiter: \"[\", line: 1], [{:<<>>, [line: 1], [\"foo\"]}, []]}, 3}"
   right: "Could not open \"foo\", file is not available"
   stacktrace:
     lib/iex/test/iex/helpers_test.exs:292: (test)

I plan to try to fix it tomorrow!

[josevalim]

The error you are getting is because of this line here. We were previously returning the term as is, without escaping, and now we are escaping it always on IEx.Helpers. We also do it in the decompose clause below. My suggestion is to make it return :error instead.

Then, inside IEx.Helpers, you can write this helper:

defp decompose(term, context) do
  case IEx.Introspection.decompose(term, context) do
    :error -> term
    m_mf_mfa -> Macro.escape(m_mf_mfa)
  end
end

And then, in mix help, you raise if decompose returns :error.

[renanroberto]

Great idea! I don't really know what to use on the raise message. Came up with Invalid expression: #{module} for now. Feel free to suggest something else!

[josevalim]

💚 💙 💜 💛 ❤️