class RubyLsp::Requests::CompletionResolve

The completionItem/resolve request provides additional information about the currently selected completion. Specifically, the labelDetails and documentation fields are provided, which are omitted from the completion items returned by textDocument/completion.

The labelDetails field lists the files where the completion item is defined, and the documentation field includes any available documentation for those definitions.

At most 10 definitions are included, to ensure low latency during request processing and rendering the completion item.

Example¶ ↑

A # -> as the user cycles through completion items, the documentation will be resolved and displayed

Constants

>MAX_DOCUMENTATION_ENTRIES: set a limit on the number of documentation entries returned, to avoid rendering performance issues github.com/Shopify/ruby-lsp/pull/1798

Public Class Methods

new(global_state, item)

Calls superclass method

# File lib/ruby_lsp/requests/completion_resolve.rb, line 33
def initialize(global_state, item)
  super()
  @index = T.let(global_state.index, RubyIndexer::Index)
  @item = item
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/completion_resolve.rb, line 40
def perform
  label = @item[:label]
  entries = @index[label] || []
  Interface::CompletionItem.new(
    label: label,
    label_details: Interface::CompletionItemLabelDetails.new(
      description: entries.take(MAX_DOCUMENTATION_ENTRIES).map(&:file_name).join(","),
    ),
    documentation: Interface::MarkupContent.new(
      kind: "markdown",
      value: markdown_from_index_entries(label, entries, MAX_DOCUMENTATION_ENTRIES),
    ),
  )
end