class RubyLsp::Requests::InlayHints

Inlay hints are labels added directly in the code that explicitly show the user something that might otherwise just be implied.

Configuration¶ ↑

To enable rescue hints, set rubyLsp.featuresConfiguration.inlayHint.implicitRescue to true.

To enable hash value hints, set rubyLsp.featuresConfiguration.inlayHint.implicitHashValue to true.

To enable all hints, set rubyLsp.featuresConfiguration.inlayHint.enableAll to true.

Example¶ ↑

begin
  puts "do something that might raise"
rescue # Label "StandardError" goes here as a bare rescue implies rescuing StandardError
  puts "handle some rescue"
end

Example¶ ↑

var = "foo"
{
  var: var, # Label "var" goes here in cases where the value is omitted
  a: "hello",
}

Public Class Methods

new(document, range, hints_configuration, dispatcher)

Calls superclass method

# File lib/ruby_lsp/requests/inlay_hints.rb, line 61
def initialize(document, range, hints_configuration, dispatcher)
  super()
  start_line = range.dig(:start, :line)
  end_line = range.dig(:end, :line)

  @response_builder = T.let(
    ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint].new,
    ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint],
  )
  Listeners::InlayHints.new(@response_builder, start_line..end_line, hints_configuration, dispatcher)
end

provider()

# File lib/ruby_lsp/requests/inlay_hints.rb, line 48
def provider
  Interface::InlayHintOptions.new(resolve_provider: false)
end

Public Instance Methods

perform()

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

class RubyLsp::Requests::InlayHints

Configuration¶ ↑

Example¶ ↑

Example¶ ↑

Public Class Methods

new(document, range, hints_configuration, dispatcher) Show source

provider() Show source

Public Instance Methods

perform() Show source

new(document, range, hints_configuration, dispatcher)

provider()

perform()