Class: RubyLsp::Listeners::SignatureHelp

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
Requests::Support::Common
Defined in:
lib/ruby_lsp/listeners/signature_help.rb

Instance Method Summary collapse

Methods included from Requests::Support::Common

#categorized_markdown_from_index_entries, #constant_name, #create_code_lens, #each_constant_path_part, #kind_for_entry, #markdown_from_index_entries, #namespace_constant_name, #not_in_dependencies?, #range_from_location, #range_from_node, #self_receiver?, #sorbet_level_true_or_higher?, #visible?

Constructor Details

#initialize(response_builder, global_state, node_context, dispatcher, sorbet_level) ⇒ SignatureHelp 



19
20
21
22
23
24
25
26
27
 
# File 'lib/ruby_lsp/listeners/signature_help.rb', line 19

def initialize(response_builder, global_state, node_context, dispatcher, sorbet_level)
  @sorbet_level = sorbet_level
  @response_builder = response_builder
  @global_state = global_state
  @index = T.let(global_state.index, RubyIndexer::Index)
  @type_inferrer = T.let(global_state.type_inferrer, TypeInferrer)
  @node_context = node_context
  dispatcher.register(self, :on_call_node_enter)
end

Instance Method Details

#on_call_node_enter(node) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/ruby_lsp/listeners/signature_help.rb', line 30

def on_call_node_enter(node)
  return if sorbet_level_true_or_higher?(@sorbet_level)

  message = node.message
  return unless message

  type = @type_inferrer.infer_receiver_type(@node_context)
  return unless type

  methods = @index.resolve_method(message, type.name)
  return unless methods

  target_method = methods.first
  return unless target_method

  parameters = target_method.parameters
  name = target_method.name

  # If the method doesn't have any parameters, there's no need to show signature help
  return if parameters.empty?

  label = "#{name}(#{parameters.map(&:decorated_name).join(", ")})"

  arguments_node = node.arguments
  arguments = arguments_node&.arguments || []
  active_parameter = (arguments.length - 1).clamp(0, parameters.length - 1)

  # If there are arguments, then we need to check if there's a trailing comma after the end of the last argument
  # to advance the active parameter to the next one
  if arguments_node &&
      node.slice.byteslice(arguments_node.location.end_offset - node.location.start_offset) == ","
    active_parameter += 1
  end

  title = +""

  extra_links = if type.is_a?(TypeInferrer::GuessedType)
    title << "\n\nGuessed receiver: #{type.name}"
    "[Learn more about guessed types](#{GUESSED_TYPES_URL})"
  end

  signature_help = Interface::SignatureHelp.new(
    signatures: [
      Interface::SignatureInformation.new(
        label: label,
        parameters: parameters.map { |param| Interface::ParameterInformation.new(label: param.name) },
        documentation: Interface::MarkupContent.new(
          kind: "markdown",
          value: markdown_from_index_entries(title, methods, extra_links: extra_links),
        ),
      ),
    ],
    active_parameter: active_parameter,
  )
  @response_builder.replace(signature_help)
end