add quick search to hexdocs.pm

[gofenix]

Change-Id: Ifd888136b0c7cd9936bf02612bd87fdcce639ba7

this pr is a hover enhancement.

before

and after this pr

we can click this hyperlink to hexdocs.pm search page, like this: https://hexdocs.pm/elixir/search.html?q=File.write

[axelson]

Hi! Thanks for this. I think this is a very interesting idea but there a few issues that need to be resolved:

• This generates a link to https://hexdocs.pm/elixir/search.html?q= for every function, even functions from the user's project and their dependencies
  • This is the primary issue
• I think we should generate a direct link to the function documentation
  • e.g. https://hexdocs.pm/elixir/File.html#write/3 instead of https://hexdocs.pm/elixir/search.html?q=File.write
• The link should be labeled more like view on hexdocs instead of changing the function name into a link

[gofenix]

Thanks for your reply.

according to you suggestions, I made some optimizations.

for issue1, only elixir std modules will be add hexdocs link. for example:

std module:

other module:

and for issue2, now can jump to function location.

[mpanarin]

its better to place the base hexdocs url into a module variable

[mpanarin]

I think we can go even further.
With mod_name.__info__(:compile) we can determine wether the module is from a dependency or not. Therefore, generate hexdocs for modules from dependencies as well

[gofenix]

yeah, i have fixed it.

[mpanarin]

We can use https://hexdocs.pm/elixir/1.12/Module.html#c:__info__/1 here as well

[gofenix]

@mpanarin thanks for your review.

I have made some changes according to your suggestion, now it can jump to both third party dependences and elixir std modules.

eg.

[lukaszsamson]

@zhenfeng-zhu please add some tests (for builtin, external, umbrella, erlang modules). Please also fix build on elixir 1.12

[lukaszsamson]

Now we need some tests and IMO it's good to go

[gofenix]

Now we need some tests and IMO it's good to go

yeah, I am doing. Thanks for your help.

[gofenix]

Now we need some tests and IMO it's good to go

@lukaszsamson I have add some tests for hover.But I don’t think it’s perfect yet. Could you give more advice on writing tests？

[mpanarin]

@lukaszsamson can this be looked at please? This feature is pretty good and can be built upon

[gofenix]

@mpanarin any update?

[gofenix]

@lukaszsamson @mpanarin @axelson Hope you anyone could review it

[lukaszsamson]

I asked for tests of erlang module and function (e.g. :ets :ets.init should link to erlang docs, but :telemetry should link to hexdocs).
I also need a test of umbrella app to see if project dir is correctly handled.

[gofenix]

I asked for tests of erlang module and function (e.g. :ets :ets.init should link to erlang docs, but :telemetry should link to hexdocs).
I also need a test of umbrella app to see if project dir is correctly handled.

thanks, i'm trying to do it!

[gofenix]

I asked for tests of erlang module and function (e.g. :ets :ets.init should link to erlang docs, but :telemetry should link to hexdocs).

For this issue, I have a question:

I find that both of :ets and : telemetry are erlang modules. Why :ets go to erlang docs , but :telemetry should go to hexdocs?

That make me confused, what is the standard of judgment?

[lukaszsamson]

You should ask OTP team why they don’t publish docs to hexdocs 😉

[gofenix]

You should ask OTP team why they don’t publish docs to hexdocs 😉

Haha, maybe in this pr, I can just not support erlang modlue link to hexdocs.

And by the way, in my test file:

def fake_dir() do
    Path.join(__DIR__, "../../../..") |> Path.expand() |> maybe_convert_path_separators()
end

I use fake_dir() as a argument as project_dir.

the fake_dir is "/Users/lucas/Documents/demos/elixirs/vscode-elixir-ls/elixir-ls", it's a umbrella app. so I guess the work is done

[lud]

Hello,

With this change, ElixirLS does not work anymore on our projects, because we are working on two projects called like SomeCustomer.SomeSubproject and SomeCustomer.DataSchemas.

As there is no SomeCustomer root module, we do not have any hover information for any of our modules.

It looks like adding a simple rescue clause solves the problem:

  defp hexdocs_link(hd, subject, project_dir) do
    # ...
  rescue
    _ in UndefinedFunctionError -> ""
  end

[lukaszsamson]

@lud please open a bug report

Edit: already tracked in #673

[lud]

Hi sorry I had to leave my home station quickly. Happy to see that is already solved.

Thanks !