Sha256: a916bb994d5baa6177129f55922aa451311ed706d590f5004d044a748a092ef1
Contents?: true
Size: 1.79 KB
Versions: 14
Compression:
Stored size: 1.79 KB
Contents
# typed: strict
# frozen_string_literal: true
require "ruby_lsp/listeners/document_highlight"
module RubyLsp
module Requests
# 
#
# The [document highlight](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight)
# 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
#
# ```ruby
# FOO = 1 # should be highlighted as "write"
#
# def foo
# FOO # should be highlighted as "read"
# end
# ```
class DocumentHighlight < Request
extend T::Sig
sig do
params(
document: Document,
position: T::Hash[Symbol, T.untyped],
dispatcher: Prism::Dispatcher,
).void
end
def initialize(document, position, dispatcher)
super()
node_context = document.locate_node(position)
@response_builder = T.let(
ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight].new,
ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight],
)
Listeners::DocumentHighlight.new(@response_builder, node_context.node, node_context.parent, dispatcher)
end
sig { override.returns(T::Array[Interface::DocumentHighlight]) }
def perform
@response_builder.response
end
end
end
end
Version data entries
14 entries across 14 versions & 1 rubygems