Class: RubyLsp::Requests::Completion

Inherits:
Request
  • Object
show all
Defined in:
lib/ruby_lsp/requests/completion.rb

Overview

The [completion](microsoft.github.io/language-server-protocol/specification#textDocument_completion) suggests possible completions according to what the developer is typing.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, global_state, params, sorbet_level, dispatcher) ⇒ Completion

: ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] params, SorbetLevel sorbet_level, Prism::Dispatcher dispatcher) -> void



25
26
27
28
29
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
86
87
88
89
 
# File 'lib/ruby_lsp/requests/completion.rb', line 25

def initialize(document, global_state, params, sorbet_level, dispatcher)
  super()
  @target = nil #: Prism::Node?
  @dispatcher = dispatcher
  # Completion always receives the position immediately after the character that was just typed. Here we adjust it
  # back by 1, so that we find the right node
  char_position, _ = document.find_index_by_position(params[:position])
  char_position -= 1
  delegate_request_if_needed!(global_state, document, char_position)

  node_context = RubyDocument.locate(
    document.ast,
    char_position,
    node_types: [
      Prism::CallNode,
      Prism::ConstantReadNode,
      Prism::ConstantPathNode,
      Prism::GlobalVariableAndWriteNode,
      Prism::GlobalVariableOperatorWriteNode,
      Prism::GlobalVariableOrWriteNode,
      Prism::GlobalVariableReadNode,
      Prism::GlobalVariableTargetNode,
      Prism::GlobalVariableWriteNode,
      Prism::InstanceVariableReadNode,
      Prism::InstanceVariableAndWriteNode,
      Prism::InstanceVariableOperatorWriteNode,
      Prism::InstanceVariableOrWriteNode,
      Prism::InstanceVariableTargetNode,
      Prism::InstanceVariableWriteNode,
      Prism::ClassVariableAndWriteNode,
      Prism::ClassVariableOperatorWriteNode,
      Prism::ClassVariableOrWriteNode,
      Prism::ClassVariableReadNode,
      Prism::ClassVariableTargetNode,
      Prism::ClassVariableWriteNode,
    ],
    code_units_cache: document.code_units_cache,
  )
  @response_builder = ResponseBuilders::CollectionResponseBuilder
    .new #: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem]

  Listeners::Completion.new(
    @response_builder,
    global_state,
    node_context,
    sorbet_level,
    dispatcher,
    document.uri,
    params.dig(:context, :triggerCharacter),
  )

  Addon.addons.each do |addon|
    addon.create_completion_listener(@response_builder, node_context, dispatcher, document.uri)
  end

  matched = node_context.node
  parent = node_context.parent
  return unless matched && parent

  @target = if parent.is_a?(Prism::ConstantPathNode) && matched.is_a?(Prism::ConstantReadNode)
    parent
  else
    matched
  end
end

Class Method Details

.provider ⇒ Object

: -> Interface::CompletionOptions



13
14
15
16
17
18
19
20
21
 
# File 'lib/ruby_lsp/requests/completion.rb', line 13

def provider
  Interface::CompletionOptions.new(
    resolve_provider: true,
    trigger_characters: ["/", "\"", "'", ":", "@", ".", "=", "<", "$"],
    completion_item: {
      labelDetailsSupport: true,
    },
  )
end

Instance Method Details

#perform ⇒ Object

: -> Array



93
94
95
96
97
98
 
# File 'lib/ruby_lsp/requests/completion.rb', line 93

def perform
  return [] unless @target

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