Composer.LSP.Hover (composer v0.2.0)

Copy Markdown View Source

Renders a Composer.LSP.Lookup result as Markdown for a hover. Every hover ends with a footer naming the host project, since a reference valid in one host may not be in another.

Summary

Functions

The footer naming the host project.

The hover text of result, or nil. host is %{project, root}; cookbooks resolve a recipe's entries.

Functions

footer(map)

@spec footer(map()) :: String.t()

The footer naming the host project.

render(result, host, cookbooks \\ [])

@spec render(Composer.LSP.Lookup.result(), map(), [Composer.Cookbook.t()]) ::
  String.t() | nil

The hover text of result, or nil. host is %{project, root}; cookbooks resolve a recipe's entries.