class RubyLsp::Requests::SignatureHelp

The signature help request displays information about the parameters of a method as you type an invocation.

Currently only supports methods invoked directly on self without taking inheritance into account.

Example¶ ↑

class Foo
 def bar(a, b, c)
 end

 def baz
   bar( # -> Signature help will show the parameters of `bar`
 end

Public Class Methods

new(document, global_state, position, context, dispatcher, typechecker_enabled)

Calls superclass method

# File lib/ruby_lsp/requests/signature_help.rb, line 52
def initialize(document, global_state, position, context, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
  super()
  target, parent, nesting = document.locate_node(
    { line: position[:line], character: position[:character] },
    node_types: [Prism::CallNode],
  )

  target = adjust_for_nested_target(target, parent, position)

  @target = T.let(target, T.nilable(Prism::Node))
  @dispatcher = dispatcher
  @response_builder = T.let(ResponseBuilders::SignatureHelp.new, ResponseBuilders::SignatureHelp)
  Listeners::SignatureHelp.new(@response_builder, global_state, nesting, dispatcher, typechecker_enabled)
end

provider()

# File lib/ruby_lsp/requests/signature_help.rb, line 34
def provider
  # Identifier characters are automatically included, such as A-Z, a-z, 0-9, _, * or :
  Interface::SignatureHelpOptions.new(
    trigger_characters: ["(", " ", ","],
  )
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/signature_help.rb, line 68
def perform
  return unless @target

  @dispatcher.dispatch_once(@target)
  @response_builder.response
end