class RubyLsp::Requests::DocumentHighlight

The document highlight informs the editor all relevant elements of the currently pointed item for highlighting. For example, when the cursor is on the F of the constant FOO, the editor should identify other occurrences of FOO and highlight them.

For writable elements like constants or variables, their read/write occurrences should be highlighted differently. This is achieved by sending different “kind” attributes to the editor (2 for read and 3 for write).

Example¶ ↑

FOO = 1 # should be highlighted as "write"

def foo
  FOO # should be highlighted as "read"
end

Public Class Methods

new(document, position, dispatcher)

Calls superclass method

# File lib/ruby_lsp/requests/document_highlight.rb, line 37
def initialize(document, position, dispatcher)
  super()
  target, parent = document.locate_node(position)
  @response_builder = T.let(
    ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight].new,
    ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight],
  )
  Listeners::DocumentHighlight.new(@response_builder, target, parent, dispatcher)
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/document_highlight.rb, line 48
def perform
  @response_builder.response
end