ruby-lsp 0.23.11 → 0.23.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/VERSION +1 -1
  4. data/exe/ruby-lsp-launcher +20 -11
  5. data/lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb +1 -1
  6. data/lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb +3 -5
  7. data/lib/ruby_indexer/lib/ruby_indexer/configuration.rb +82 -116
  8. data/lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb +123 -169
  9. data/lib/ruby_indexer/lib/ruby_indexer/enhancement.rb +9 -7
  10. data/lib/ruby_indexer/lib/ruby_indexer/entry.rb +92 -202
  11. data/lib/ruby_indexer/lib/ruby_indexer/index.rb +116 -222
  12. data/lib/ruby_indexer/lib/ruby_indexer/location.rb +4 -27
  13. data/lib/ruby_indexer/lib/ruby_indexer/prefix_tree.rb +18 -19
  14. data/lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb +22 -45
  15. data/lib/ruby_indexer/lib/ruby_indexer/reference_finder.rb +47 -61
  16. data/lib/ruby_indexer/lib/ruby_indexer/uri.rb +17 -19
  17. data/lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb +5 -9
  18. data/lib/ruby_indexer/test/class_variables_test.rb +14 -14
  19. data/lib/ruby_indexer/test/classes_and_modules_test.rb +65 -40
  20. data/lib/ruby_indexer/test/configuration_test.rb +48 -7
  21. data/lib/ruby_indexer/test/constant_test.rb +34 -34
  22. data/lib/ruby_indexer/test/enhancements_test.rb +1 -1
  23. data/lib/ruby_indexer/test/index_test.rb +139 -135
  24. data/lib/ruby_indexer/test/instance_variables_test.rb +37 -37
  25. data/lib/ruby_indexer/test/method_test.rb +143 -117
  26. data/lib/ruby_indexer/test/prefix_tree_test.rb +13 -13
  27. data/lib/ruby_indexer/test/rbs_indexer_test.rb +65 -71
  28. data/lib/ruby_indexer/test/test_case.rb +2 -2
  29. data/lib/ruby_indexer/test/uri_test.rb +15 -2
  30. data/lib/ruby_lsp/addon.rb +44 -71
  31. data/lib/ruby_lsp/base_server.rb +29 -32
  32. data/lib/ruby_lsp/client_capabilities.rb +10 -12
  33. data/lib/ruby_lsp/document.rb +39 -45
  34. data/lib/ruby_lsp/erb_document.rb +36 -40
  35. data/lib/ruby_lsp/global_state.rb +52 -57
  36. data/lib/ruby_lsp/internal.rb +2 -0
  37. data/lib/ruby_lsp/listeners/code_lens.rb +82 -89
  38. data/lib/ruby_lsp/listeners/completion.rb +60 -66
  39. data/lib/ruby_lsp/listeners/definition.rb +38 -52
  40. data/lib/ruby_lsp/listeners/document_highlight.rb +123 -150
  41. data/lib/ruby_lsp/listeners/document_link.rb +46 -63
  42. data/lib/ruby_lsp/listeners/document_symbol.rb +38 -52
  43. data/lib/ruby_lsp/listeners/folding_ranges.rb +40 -43
  44. data/lib/ruby_lsp/listeners/hover.rb +83 -102
  45. data/lib/ruby_lsp/listeners/inlay_hints.rb +4 -11
  46. data/lib/ruby_lsp/listeners/semantic_highlighting.rb +54 -56
  47. data/lib/ruby_lsp/listeners/signature_help.rb +11 -26
  48. data/lib/ruby_lsp/listeners/spec_style.rb +155 -0
  49. data/lib/ruby_lsp/listeners/test_discovery.rb +89 -0
  50. data/lib/ruby_lsp/listeners/test_style.rb +160 -88
  51. data/lib/ruby_lsp/node_context.rb +12 -39
  52. data/lib/ruby_lsp/rbs_document.rb +8 -6
  53. data/lib/ruby_lsp/requests/code_action_resolve.rb +24 -25
  54. data/lib/ruby_lsp/requests/code_actions.rb +14 -26
  55. data/lib/ruby_lsp/requests/code_lens.rb +6 -17
  56. data/lib/ruby_lsp/requests/completion.rb +7 -20
  57. data/lib/ruby_lsp/requests/completion_resolve.rb +6 -6
  58. data/lib/ruby_lsp/requests/definition.rb +8 -17
  59. data/lib/ruby_lsp/requests/diagnostics.rb +8 -11
  60. data/lib/ruby_lsp/requests/discover_tests.rb +18 -5
  61. data/lib/ruby_lsp/requests/document_highlight.rb +5 -15
  62. data/lib/ruby_lsp/requests/document_link.rb +6 -17
  63. data/lib/ruby_lsp/requests/document_symbol.rb +5 -8
  64. data/lib/ruby_lsp/requests/folding_ranges.rb +7 -15
  65. data/lib/ruby_lsp/requests/formatting.rb +6 -9
  66. data/lib/ruby_lsp/requests/go_to_relevant_file.rb +87 -0
  67. data/lib/ruby_lsp/requests/hover.rb +10 -20
  68. data/lib/ruby_lsp/requests/inlay_hints.rb +6 -17
  69. data/lib/ruby_lsp/requests/on_type_formatting.rb +32 -40
  70. data/lib/ruby_lsp/requests/prepare_rename.rb +4 -9
  71. data/lib/ruby_lsp/requests/prepare_type_hierarchy.rb +5 -15
  72. data/lib/ruby_lsp/requests/range_formatting.rb +5 -6
  73. data/lib/ruby_lsp/requests/references.rb +8 -37
  74. data/lib/ruby_lsp/requests/rename.rb +19 -42
  75. data/lib/ruby_lsp/requests/request.rb +7 -19
  76. data/lib/ruby_lsp/requests/selection_ranges.rb +6 -6
  77. data/lib/ruby_lsp/requests/semantic_highlighting.rb +16 -35
  78. data/lib/ruby_lsp/requests/show_syntax_tree.rb +7 -8
  79. data/lib/ruby_lsp/requests/signature_help.rb +8 -26
  80. data/lib/ruby_lsp/requests/support/annotation.rb +4 -10
  81. data/lib/ruby_lsp/requests/support/common.rb +16 -51
  82. data/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb +27 -35
  83. data/lib/ruby_lsp/requests/support/rubocop_formatter.rb +11 -14
  84. data/lib/ruby_lsp/requests/support/rubocop_runner.rb +22 -34
  85. data/lib/ruby_lsp/requests/support/selection_range.rb +1 -3
  86. data/lib/ruby_lsp/requests/support/sorbet.rb +29 -38
  87. data/lib/ruby_lsp/requests/support/source_uri.rb +20 -32
  88. data/lib/ruby_lsp/requests/support/syntax_tree_formatter.rb +12 -19
  89. data/lib/ruby_lsp/requests/support/test_item.rb +10 -14
  90. data/lib/ruby_lsp/requests/type_hierarchy_supertypes.rb +5 -6
  91. data/lib/ruby_lsp/requests/workspace_symbol.rb +4 -4
  92. data/lib/ruby_lsp/response_builders/collection_response_builder.rb +5 -5
  93. data/lib/ruby_lsp/response_builders/document_symbol.rb +13 -18
  94. data/lib/ruby_lsp/response_builders/hover.rb +11 -14
  95. data/lib/ruby_lsp/response_builders/response_builder.rb +1 -1
  96. data/lib/ruby_lsp/response_builders/semantic_highlighting.rb +60 -88
  97. data/lib/ruby_lsp/response_builders/signature_help.rb +5 -6
  98. data/lib/ruby_lsp/response_builders/test_collection.rb +6 -10
  99. data/lib/ruby_lsp/ruby_document.rb +24 -62
  100. data/lib/ruby_lsp/scope.rb +7 -11
  101. data/lib/ruby_lsp/scripts/compose_bundle.rb +6 -4
  102. data/lib/ruby_lsp/server.rb +147 -79
  103. data/lib/ruby_lsp/setup_bundler.rb +65 -60
  104. data/lib/ruby_lsp/static_docs.rb +11 -7
  105. data/lib/ruby_lsp/store.rb +24 -42
  106. data/lib/ruby_lsp/test_helper.rb +2 -12
  107. data/lib/ruby_lsp/test_reporters/lsp_reporter.rb +164 -0
  108. data/lib/ruby_lsp/test_reporters/minitest_reporter.rb +105 -0
  109. data/lib/ruby_lsp/test_reporters/test_unit_reporter.rb +94 -0
  110. data/lib/ruby_lsp/type_inferrer.rb +13 -14
  111. data/lib/ruby_lsp/utils.rb +49 -83
  112. metadata +9 -3
@@ -4,7 +4,6 @@
4
4
  module RubyLsp
5
5
  module Listeners
6
6
  class Completion
7
- extend T::Sig
8
7
  include Requests::Support::Common
9
8
 
10
9
  KEYWORDS = [
@@ -51,17 +50,7 @@ module RubyLsp
51
50
  "__LINE__",
52
51
  ].freeze
53
52
 
54
- sig do
55
- params(
56
- response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
57
- global_state: GlobalState,
58
- node_context: NodeContext,
59
- sorbet_level: RubyDocument::SorbetLevel,
60
- dispatcher: Prism::Dispatcher,
61
- uri: URI::Generic,
62
- trigger_character: T.nilable(String),
63
- ).void
64
- end
53
+ #: (ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem] response_builder, GlobalState global_state, NodeContext node_context, RubyDocument::SorbetLevel sorbet_level, Prism::Dispatcher dispatcher, URI::Generic uri, String? trigger_character) -> void
65
54
  def initialize( # rubocop:disable Metrics/ParameterLists
66
55
  response_builder,
67
56
  global_state,
@@ -73,8 +62,8 @@ module RubyLsp
73
62
  )
74
63
  @response_builder = response_builder
75
64
  @global_state = global_state
76
- @index = T.let(global_state.index, RubyIndexer::Index)
77
- @type_inferrer = T.let(global_state.type_inferrer, TypeInferrer)
65
+ @index = global_state.index #: RubyIndexer::Index
66
+ @type_inferrer = global_state.type_inferrer #: TypeInferrer
78
67
  @node_context = node_context
79
68
  @sorbet_level = sorbet_level
80
69
  @uri = uri
@@ -107,7 +96,7 @@ module RubyLsp
107
96
  end
108
97
 
109
98
  # Handle completion on regular constant references (e.g. `Bar`)
110
- sig { params(node: Prism::ConstantReadNode).void }
99
+ #: (Prism::ConstantReadNode node) -> void
111
100
  def on_constant_read_node_enter(node)
112
101
  # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
113
102
  # no sigil, Sorbet will still provide completion for constants
@@ -119,7 +108,8 @@ module RubyLsp
119
108
  range = range_from_location(node.location)
120
109
  candidates = @index.constant_completion_candidates(name, @node_context.nesting)
121
110
  candidates.each do |entries|
122
- complete_name = T.must(entries.first).name
111
+ complete_name = entries.first #: as !nil
112
+ .name
123
113
  @response_builder << build_entry_completion(
124
114
  complete_name,
125
115
  name,
@@ -131,7 +121,7 @@ module RubyLsp
131
121
  end
132
122
 
133
123
  # Handle completion on namespaced constant references (e.g. `Foo::Bar`)
134
- sig { params(node: Prism::ConstantPathNode).void }
124
+ #: (Prism::ConstantPathNode node) -> void
135
125
  def on_constant_path_node_enter(node)
136
126
  # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
137
127
  # no sigil, Sorbet will still provide completion for constants
@@ -149,7 +139,7 @@ module RubyLsp
149
139
  constant_path_completion(name, range_from_location(node.location))
150
140
  end
151
141
 
152
- sig { params(node: Prism::CallNode).void }
142
+ #: (Prism::CallNode node) -> void
153
143
  def on_call_node_enter(node)
154
144
  # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
155
145
  # no sigil, Sorbet will still provide completion for constants
@@ -166,7 +156,7 @@ module RubyLsp
166
156
 
167
157
  if name
168
158
  start_loc = node.location
169
- end_loc = T.must(node.call_operator_loc)
159
+ end_loc = node.call_operator_loc #: as !nil
170
160
 
171
161
  constant_path_completion(
172
162
  "#{name}::",
@@ -193,99 +183,99 @@ module RubyLsp
193
183
  end
194
184
  end
195
185
 
196
- sig { params(node: Prism::GlobalVariableAndWriteNode).void }
186
+ #: (Prism::GlobalVariableAndWriteNode node) -> void
197
187
  def on_global_variable_and_write_node_enter(node)
198
188
  handle_global_variable_completion(node.name.to_s, node.name_loc)
199
189
  end
200
190
 
201
- sig { params(node: Prism::GlobalVariableOperatorWriteNode).void }
191
+ #: (Prism::GlobalVariableOperatorWriteNode node) -> void
202
192
  def on_global_variable_operator_write_node_enter(node)
203
193
  handle_global_variable_completion(node.name.to_s, node.name_loc)
204
194
  end
205
195
 
206
- sig { params(node: Prism::GlobalVariableOrWriteNode).void }
196
+ #: (Prism::GlobalVariableOrWriteNode node) -> void
207
197
  def on_global_variable_or_write_node_enter(node)
208
198
  handle_global_variable_completion(node.name.to_s, node.name_loc)
209
199
  end
210
200
 
211
- sig { params(node: Prism::GlobalVariableReadNode).void }
201
+ #: (Prism::GlobalVariableReadNode node) -> void
212
202
  def on_global_variable_read_node_enter(node)
213
203
  handle_global_variable_completion(node.name.to_s, node.location)
214
204
  end
215
205
 
216
- sig { params(node: Prism::GlobalVariableTargetNode).void }
206
+ #: (Prism::GlobalVariableTargetNode node) -> void
217
207
  def on_global_variable_target_node_enter(node)
218
208
  handle_global_variable_completion(node.name.to_s, node.location)
219
209
  end
220
210
 
221
- sig { params(node: Prism::GlobalVariableWriteNode).void }
211
+ #: (Prism::GlobalVariableWriteNode node) -> void
222
212
  def on_global_variable_write_node_enter(node)
223
213
  handle_global_variable_completion(node.name.to_s, node.name_loc)
224
214
  end
225
215
 
226
- sig { params(node: Prism::InstanceVariableReadNode).void }
216
+ #: (Prism::InstanceVariableReadNode node) -> void
227
217
  def on_instance_variable_read_node_enter(node)
228
218
  handle_instance_variable_completion(node.name.to_s, node.location)
229
219
  end
230
220
 
231
- sig { params(node: Prism::InstanceVariableWriteNode).void }
221
+ #: (Prism::InstanceVariableWriteNode node) -> void
232
222
  def on_instance_variable_write_node_enter(node)
233
223
  handle_instance_variable_completion(node.name.to_s, node.name_loc)
234
224
  end
235
225
 
236
- sig { params(node: Prism::InstanceVariableAndWriteNode).void }
226
+ #: (Prism::InstanceVariableAndWriteNode node) -> void
237
227
  def on_instance_variable_and_write_node_enter(node)
238
228
  handle_instance_variable_completion(node.name.to_s, node.name_loc)
239
229
  end
240
230
 
241
- sig { params(node: Prism::InstanceVariableOperatorWriteNode).void }
231
+ #: (Prism::InstanceVariableOperatorWriteNode node) -> void
242
232
  def on_instance_variable_operator_write_node_enter(node)
243
233
  handle_instance_variable_completion(node.name.to_s, node.name_loc)
244
234
  end
245
235
 
246
- sig { params(node: Prism::InstanceVariableOrWriteNode).void }
236
+ #: (Prism::InstanceVariableOrWriteNode node) -> void
247
237
  def on_instance_variable_or_write_node_enter(node)
248
238
  handle_instance_variable_completion(node.name.to_s, node.name_loc)
249
239
  end
250
240
 
251
- sig { params(node: Prism::InstanceVariableTargetNode).void }
241
+ #: (Prism::InstanceVariableTargetNode node) -> void
252
242
  def on_instance_variable_target_node_enter(node)
253
243
  handle_instance_variable_completion(node.name.to_s, node.location)
254
244
  end
255
245
 
256
- sig { params(node: Prism::ClassVariableAndWriteNode).void }
246
+ #: (Prism::ClassVariableAndWriteNode node) -> void
257
247
  def on_class_variable_and_write_node_enter(node)
258
248
  handle_class_variable_completion(node.name.to_s, node.name_loc)
259
249
  end
260
250
 
261
- sig { params(node: Prism::ClassVariableOperatorWriteNode).void }
251
+ #: (Prism::ClassVariableOperatorWriteNode node) -> void
262
252
  def on_class_variable_operator_write_node_enter(node)
263
253
  handle_class_variable_completion(node.name.to_s, node.name_loc)
264
254
  end
265
255
 
266
- sig { params(node: Prism::ClassVariableOrWriteNode).void }
256
+ #: (Prism::ClassVariableOrWriteNode node) -> void
267
257
  def on_class_variable_or_write_node_enter(node)
268
258
  handle_class_variable_completion(node.name.to_s, node.name_loc)
269
259
  end
270
260
 
271
- sig { params(node: Prism::ClassVariableTargetNode).void }
261
+ #: (Prism::ClassVariableTargetNode node) -> void
272
262
  def on_class_variable_target_node_enter(node)
273
263
  handle_class_variable_completion(node.name.to_s, node.location)
274
264
  end
275
265
 
276
- sig { params(node: Prism::ClassVariableReadNode).void }
266
+ #: (Prism::ClassVariableReadNode node) -> void
277
267
  def on_class_variable_read_node_enter(node)
278
268
  handle_class_variable_completion(node.name.to_s, node.location)
279
269
  end
280
270
 
281
- sig { params(node: Prism::ClassVariableWriteNode).void }
271
+ #: (Prism::ClassVariableWriteNode node) -> void
282
272
  def on_class_variable_write_node_enter(node)
283
273
  handle_class_variable_completion(node.name.to_s, node.name_loc)
284
274
  end
285
275
 
286
276
  private
287
277
 
288
- sig { params(name: String, range: Interface::Range).void }
278
+ #: (String name, Interface::Range range) -> void
289
279
  def constant_path_completion(name, range)
290
280
  top_level_reference = if name.start_with?("::")
291
281
  name = name.delete_prefix("::")
@@ -307,7 +297,9 @@ module RubyLsp
307
297
  namespace_entries = @index.resolve(aliased_namespace, nesting)
308
298
  return unless namespace_entries
309
299
 
310
- real_namespace = @index.follow_aliased_namespace(T.must(namespace_entries.first).name)
300
+ namespace_name = namespace_entries.first #: as !nil
301
+ .name
302
+ real_namespace = @index.follow_aliased_namespace(namespace_name)
311
303
 
312
304
  candidates = @index.constant_completion_candidates(
313
305
  "#{real_namespace}::#{incomplete_name}",
@@ -316,7 +308,7 @@ module RubyLsp
316
308
  candidates.each do |entries|
317
309
  # The only time we may have a private constant reference from outside of the namespace is if we're dealing
318
310
  # with ConstantPath and the entry name doesn't start with the current nesting
319
- first_entry = T.must(entries.first)
311
+ first_entry = entries.first #: as !nil
320
312
  next if first_entry.private? && !first_entry.name.start_with?("#{nesting}::")
321
313
 
322
314
  entry_name = first_entry.name
@@ -335,12 +327,12 @@ module RubyLsp
335
327
  name,
336
328
  range,
337
329
  entries,
338
- top_level_reference || top_level?(T.must(entries.first).name),
330
+ top_level_reference || top_level?(first_entry.name),
339
331
  )
340
332
  end
341
333
  end
342
334
 
343
- sig { params(name: String, location: Prism::Location).void }
335
+ #: (String name, Prism::Location location) -> void
344
336
  def handle_global_variable_completion(name, location)
345
337
  candidates = @index.prefix_search(name)
346
338
 
@@ -363,7 +355,7 @@ module RubyLsp
363
355
  end
364
356
  end
365
357
 
366
- sig { params(name: String, location: Prism::Location).void }
358
+ #: (String name, Prism::Location location) -> void
367
359
  def handle_class_variable_completion(name, location)
368
360
  type = @type_inferrer.infer_receiver_type(@node_context)
369
361
  return unless type
@@ -394,7 +386,7 @@ module RubyLsp
394
386
  # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
395
387
  end
396
388
 
397
- sig { params(name: String, location: Prism::Location).void }
389
+ #: (String name, Prism::Location location) -> void
398
390
  def handle_instance_variable_completion(name, location)
399
391
  # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
400
392
  # to provide all features for them
@@ -428,7 +420,7 @@ module RubyLsp
428
420
  # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
429
421
  end
430
422
 
431
- sig { params(node: Prism::CallNode).void }
423
+ #: (Prism::CallNode node) -> void
432
424
  def complete_require(node)
433
425
  arguments_node = node.arguments
434
426
  return unless arguments_node
@@ -440,11 +432,14 @@ module RubyLsp
440
432
  matched_uris = @index.search_require_paths(path_node_to_complete.content)
441
433
 
442
434
  matched_uris.map!(&:require_path).sort!.each do |path|
443
- @response_builder << build_completion(T.must(path), path_node_to_complete)
435
+ @response_builder << build_completion(
436
+ path, #: as !nil
437
+ path_node_to_complete,
438
+ )
444
439
  end
445
440
  end
446
441
 
447
- sig { params(node: Prism::CallNode).void }
442
+ #: (Prism::CallNode node) -> void
448
443
  def complete_require_relative(node)
449
444
  arguments_node = node.arguments
450
445
  return unless arguments_node
@@ -476,7 +471,7 @@ module RubyLsp
476
471
  # might fail with EPERM
477
472
  end
478
473
 
479
- sig { params(node: Prism::CallNode, name: String).void }
474
+ #: (Prism::CallNode node, String name) -> void
480
475
  def complete_methods(node, name)
481
476
  # If the node has a receiver, then we don't need to provide local nor keyword completions. Sorbet can provide
482
477
  # local and keyword completion for any file with a Sorbet level of true or higher
@@ -497,7 +492,9 @@ module RubyLsp
497
492
  method_name = @trigger_character == "." ? nil : name
498
493
 
499
494
  range = if method_name
500
- range_from_location(T.must(node.message_loc))
495
+ range_from_location(
496
+ node.message_loc, #: as !nil
497
+ )
501
498
  else
502
499
  loc = node.call_operator_loc
503
500
 
@@ -540,9 +537,11 @@ module RubyLsp
540
537
  # We have not indexed this namespace, so we can't provide any completions
541
538
  end
542
539
 
543
- sig { params(node: Prism::CallNode, name: String).void }
540
+ #: (Prism::CallNode node, String name) -> void
544
541
  def add_local_completions(node, name)
545
- range = range_from_location(T.must(node.message_loc))
542
+ range = range_from_location(
543
+ node.message_loc, #: as !nil
544
+ )
546
545
 
547
546
  @node_context.locals_for_scope.each do |local|
548
547
  local_name = local.to_s
@@ -560,9 +559,11 @@ module RubyLsp
560
559
  end
561
560
  end
562
561
 
563
- sig { params(node: Prism::CallNode, name: String).void }
562
+ #: (Prism::CallNode node, String name) -> void
564
563
  def add_keyword_completions(node, name)
565
- range = range_from_location(T.must(node.message_loc))
564
+ range = range_from_location(
565
+ node.message_loc, #: as !nil
566
+ )
566
567
 
567
568
  KEYWORDS.each do |keyword|
568
569
  next unless keyword.start_with?(name)
@@ -578,7 +579,7 @@ module RubyLsp
578
579
  end
579
580
  end
580
581
 
581
- sig { params(label: String, node: Prism::StringNode).returns(Interface::CompletionItem) }
582
+ #: (String label, Prism::StringNode node) -> Interface::CompletionItem
582
583
  def build_completion(label, node)
583
584
  # We should use the content location as we only replace the content and not the delimiters of the string
584
585
  loc = node.content_loc
@@ -593,17 +594,9 @@ module RubyLsp
593
594
  )
594
595
  end
595
596
 
596
- sig do
597
- params(
598
- real_name: String,
599
- incomplete_name: String,
600
- range: Interface::Range,
601
- entries: T::Array[RubyIndexer::Entry],
602
- top_level: T::Boolean,
603
- ).returns(Interface::CompletionItem)
604
- end
597
+ #: (String real_name, String incomplete_name, Interface::Range range, Array[RubyIndexer::Entry] entries, bool top_level) -> Interface::CompletionItem
605
598
  def build_entry_completion(real_name, incomplete_name, range, entries, top_level)
606
- first_entry = T.must(entries.first)
599
+ first_entry = entries.first #: as !nil
607
600
  kind = case first_entry
608
601
  when RubyIndexer::Entry::Class
609
602
  Constant::CompletionItemKind::CLASS
@@ -690,11 +683,12 @@ module RubyLsp
690
683
  # B
691
684
  # end
692
685
  # ```
693
- sig { params(entry_name: String).returns(T::Boolean) }
686
+ #: (String entry_name) -> bool
694
687
  def top_level?(entry_name)
695
688
  nesting = @node_context.nesting
696
689
  nesting.length.downto(0) do |i|
697
- prefix = T.must(nesting[0...i]).join("::")
690
+ prefix = nesting[0...i] #: as !nil
691
+ .join("::")
698
692
  full_name = prefix.empty? ? entry_name : "#{prefix}::#{entry_name}"
699
693
  next if full_name == entry_name
700
694
 
@@ -4,30 +4,16 @@
4
4
  module RubyLsp
5
5
  module Listeners
6
6
  class Definition
7
- extend T::Sig
8
7
  include Requests::Support::Common
9
8
 
10
9
  MAX_NUMBER_OF_DEFINITION_CANDIDATES_WITHOUT_RECEIVER = 10
11
10
 
12
- sig do
13
- params(
14
- response_builder: ResponseBuilders::CollectionResponseBuilder[T.any(
15
- Interface::Location,
16
- Interface::LocationLink,
17
- )],
18
- global_state: GlobalState,
19
- language_id: Document::LanguageId,
20
- uri: URI::Generic,
21
- node_context: NodeContext,
22
- dispatcher: Prism::Dispatcher,
23
- sorbet_level: RubyDocument::SorbetLevel,
24
- ).void
25
- end
11
+ #: (ResponseBuilders::CollectionResponseBuilder[(Interface::Location | Interface::LocationLink)] response_builder, GlobalState global_state, Document::LanguageId language_id, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
26
12
  def initialize(response_builder, global_state, language_id, uri, node_context, dispatcher, sorbet_level) # rubocop:disable Metrics/ParameterLists
27
13
  @response_builder = response_builder
28
14
  @global_state = global_state
29
- @index = T.let(global_state.index, RubyIndexer::Index)
30
- @type_inferrer = T.let(global_state.type_inferrer, TypeInferrer)
15
+ @index = global_state.index #: RubyIndexer::Index
16
+ @type_inferrer = global_state.type_inferrer #: TypeInferrer
31
17
  @language_id = language_id
32
18
  @uri = uri
33
19
  @node_context = node_context
@@ -64,7 +50,7 @@ module RubyLsp
64
50
  )
65
51
  end
66
52
 
67
- sig { params(node: Prism::CallNode).void }
53
+ #: (Prism::CallNode node) -> void
68
54
  def on_call_node_enter(node)
69
55
  # Sorbet can handle go to definition for methods invoked on self on typed true or higher
70
56
  return if sorbet_level_true_or_higher?(@sorbet_level) && self_receiver?(node)
@@ -83,7 +69,7 @@ module RubyLsp
83
69
  handle_method_definition(message, inferrer_receiver_type)
84
70
  end
85
71
 
86
- sig { params(node: Prism::StringNode).void }
72
+ #: (Prism::StringNode node) -> void
87
73
  def on_string_node_enter(node)
88
74
  enclosing_call = @node_context.call_node
89
75
  return unless enclosing_call
@@ -94,7 +80,7 @@ module RubyLsp
94
80
  handle_require_definition(node, name)
95
81
  end
96
82
 
97
- sig { params(node: Prism::SymbolNode).void }
83
+ #: (Prism::SymbolNode node) -> void
98
84
  def on_symbol_node_enter(node)
99
85
  enclosing_call = @node_context.call_node
100
86
  return unless enclosing_call
@@ -105,7 +91,7 @@ module RubyLsp
105
91
  handle_autoload_definition(enclosing_call)
106
92
  end
107
93
 
108
- sig { params(node: Prism::BlockArgumentNode).void }
94
+ #: (Prism::BlockArgumentNode node) -> void
109
95
  def on_block_argument_node_enter(node)
110
96
  expression = node.expression
111
97
  return unless expression.is_a?(Prism::SymbolNode)
@@ -116,7 +102,7 @@ module RubyLsp
116
102
  handle_method_definition(value, nil)
117
103
  end
118
104
 
119
- sig { params(node: Prism::ConstantPathNode).void }
105
+ #: (Prism::ConstantPathNode node) -> void
120
106
  def on_constant_path_node_enter(node)
121
107
  name = RubyIndexer::Index.constant_name(node)
122
108
  return if name.nil?
@@ -124,7 +110,7 @@ module RubyLsp
124
110
  find_in_index(name)
125
111
  end
126
112
 
127
- sig { params(node: Prism::ConstantReadNode).void }
113
+ #: (Prism::ConstantReadNode node) -> void
128
114
  def on_constant_read_node_enter(node)
129
115
  name = RubyIndexer::Index.constant_name(node)
130
116
  return if name.nil?
@@ -132,109 +118,109 @@ module RubyLsp
132
118
  find_in_index(name)
133
119
  end
134
120
 
135
- sig { params(node: Prism::GlobalVariableAndWriteNode).void }
121
+ #: (Prism::GlobalVariableAndWriteNode node) -> void
136
122
  def on_global_variable_and_write_node_enter(node)
137
123
  handle_global_variable_definition(node.name.to_s)
138
124
  end
139
125
 
140
- sig { params(node: Prism::GlobalVariableOperatorWriteNode).void }
126
+ #: (Prism::GlobalVariableOperatorWriteNode node) -> void
141
127
  def on_global_variable_operator_write_node_enter(node)
142
128
  handle_global_variable_definition(node.name.to_s)
143
129
  end
144
130
 
145
- sig { params(node: Prism::GlobalVariableOrWriteNode).void }
131
+ #: (Prism::GlobalVariableOrWriteNode node) -> void
146
132
  def on_global_variable_or_write_node_enter(node)
147
133
  handle_global_variable_definition(node.name.to_s)
148
134
  end
149
135
 
150
- sig { params(node: Prism::GlobalVariableReadNode).void }
136
+ #: (Prism::GlobalVariableReadNode node) -> void
151
137
  def on_global_variable_read_node_enter(node)
152
138
  handle_global_variable_definition(node.name.to_s)
153
139
  end
154
140
 
155
- sig { params(node: Prism::GlobalVariableTargetNode).void }
141
+ #: (Prism::GlobalVariableTargetNode node) -> void
156
142
  def on_global_variable_target_node_enter(node)
157
143
  handle_global_variable_definition(node.name.to_s)
158
144
  end
159
145
 
160
- sig { params(node: Prism::GlobalVariableWriteNode).void }
146
+ #: (Prism::GlobalVariableWriteNode node) -> void
161
147
  def on_global_variable_write_node_enter(node)
162
148
  handle_global_variable_definition(node.name.to_s)
163
149
  end
164
150
 
165
- sig { params(node: Prism::InstanceVariableReadNode).void }
151
+ #: (Prism::InstanceVariableReadNode node) -> void
166
152
  def on_instance_variable_read_node_enter(node)
167
153
  handle_instance_variable_definition(node.name.to_s)
168
154
  end
169
155
 
170
- sig { params(node: Prism::InstanceVariableWriteNode).void }
156
+ #: (Prism::InstanceVariableWriteNode node) -> void
171
157
  def on_instance_variable_write_node_enter(node)
172
158
  handle_instance_variable_definition(node.name.to_s)
173
159
  end
174
160
 
175
- sig { params(node: Prism::InstanceVariableAndWriteNode).void }
161
+ #: (Prism::InstanceVariableAndWriteNode node) -> void
176
162
  def on_instance_variable_and_write_node_enter(node)
177
163
  handle_instance_variable_definition(node.name.to_s)
178
164
  end
179
165
 
180
- sig { params(node: Prism::InstanceVariableOperatorWriteNode).void }
166
+ #: (Prism::InstanceVariableOperatorWriteNode node) -> void
181
167
  def on_instance_variable_operator_write_node_enter(node)
182
168
  handle_instance_variable_definition(node.name.to_s)
183
169
  end
184
170
 
185
- sig { params(node: Prism::InstanceVariableOrWriteNode).void }
171
+ #: (Prism::InstanceVariableOrWriteNode node) -> void
186
172
  def on_instance_variable_or_write_node_enter(node)
187
173
  handle_instance_variable_definition(node.name.to_s)
188
174
  end
189
175
 
190
- sig { params(node: Prism::InstanceVariableTargetNode).void }
176
+ #: (Prism::InstanceVariableTargetNode node) -> void
191
177
  def on_instance_variable_target_node_enter(node)
192
178
  handle_instance_variable_definition(node.name.to_s)
193
179
  end
194
180
 
195
- sig { params(node: Prism::SuperNode).void }
181
+ #: (Prism::SuperNode node) -> void
196
182
  def on_super_node_enter(node)
197
183
  handle_super_node_definition
198
184
  end
199
185
 
200
- sig { params(node: Prism::ForwardingSuperNode).void }
186
+ #: (Prism::ForwardingSuperNode node) -> void
201
187
  def on_forwarding_super_node_enter(node)
202
188
  handle_super_node_definition
203
189
  end
204
190
 
205
- sig { params(node: Prism::ClassVariableAndWriteNode).void }
191
+ #: (Prism::ClassVariableAndWriteNode node) -> void
206
192
  def on_class_variable_and_write_node_enter(node)
207
193
  handle_class_variable_definition(node.name.to_s)
208
194
  end
209
195
 
210
- sig { params(node: Prism::ClassVariableOperatorWriteNode).void }
196
+ #: (Prism::ClassVariableOperatorWriteNode node) -> void
211
197
  def on_class_variable_operator_write_node_enter(node)
212
198
  handle_class_variable_definition(node.name.to_s)
213
199
  end
214
200
 
215
- sig { params(node: Prism::ClassVariableOrWriteNode).void }
201
+ #: (Prism::ClassVariableOrWriteNode node) -> void
216
202
  def on_class_variable_or_write_node_enter(node)
217
203
  handle_class_variable_definition(node.name.to_s)
218
204
  end
219
205
 
220
- sig { params(node: Prism::ClassVariableTargetNode).void }
206
+ #: (Prism::ClassVariableTargetNode node) -> void
221
207
  def on_class_variable_target_node_enter(node)
222
208
  handle_class_variable_definition(node.name.to_s)
223
209
  end
224
210
 
225
- sig { params(node: Prism::ClassVariableReadNode).void }
211
+ #: (Prism::ClassVariableReadNode node) -> void
226
212
  def on_class_variable_read_node_enter(node)
227
213
  handle_class_variable_definition(node.name.to_s)
228
214
  end
229
215
 
230
- sig { params(node: Prism::ClassVariableWriteNode).void }
216
+ #: (Prism::ClassVariableWriteNode node) -> void
231
217
  def on_class_variable_write_node_enter(node)
232
218
  handle_class_variable_definition(node.name.to_s)
233
219
  end
234
220
 
235
221
  private
236
222
 
237
- sig { void }
223
+ #: -> void
238
224
  def handle_super_node_definition
239
225
  # Sorbet can handle super hover on typed true or higher
240
226
  return if sorbet_level_true_or_higher?(@sorbet_level)
@@ -249,7 +235,7 @@ module RubyLsp
249
235
  )
250
236
  end
251
237
 
252
- sig { params(name: String).void }
238
+ #: (String name) -> void
253
239
  def handle_global_variable_definition(name)
254
240
  entries = @index[name]
255
241
 
@@ -268,7 +254,7 @@ module RubyLsp
268
254
  end
269
255
  end
270
256
 
271
- sig { params(name: String).void }
257
+ #: (String name) -> void
272
258
  def handle_class_variable_definition(name)
273
259
  type = @type_inferrer.infer_receiver_type(@node_context)
274
260
  return unless type
@@ -286,7 +272,7 @@ module RubyLsp
286
272
  # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
287
273
  end
288
274
 
289
- sig { params(name: String).void }
275
+ #: (String name) -> void
290
276
  def handle_instance_variable_definition(name)
291
277
  # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
292
278
  # to provide all features for them
@@ -313,7 +299,7 @@ module RubyLsp
313
299
  # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
314
300
  end
315
301
 
316
- sig { params(message: String, receiver_type: T.nilable(TypeInferrer::Type), inherited_only: T::Boolean).void }
302
+ #: (String message, TypeInferrer::Type? receiver_type, ?inherited_only: bool) -> void
317
303
  def handle_method_definition(message, receiver_type, inherited_only: false)
318
304
  methods = if receiver_type
319
305
  @index.resolve_method(message, receiver_type.name, inherited_only: inherited_only)
@@ -341,7 +327,7 @@ module RubyLsp
341
327
  end
342
328
  end
343
329
 
344
- sig { params(node: Prism::StringNode, message: Symbol).void }
330
+ #: (Prism::StringNode node, Symbol message) -> void
345
331
  def handle_require_definition(node, message)
346
332
  case message
347
333
  when :require
@@ -378,7 +364,7 @@ module RubyLsp
378
364
  end
379
365
  end
380
366
 
381
- sig { params(node: Prism::CallNode).void }
367
+ #: (Prism::CallNode node) -> void
382
368
  def handle_autoload_definition(node)
383
369
  argument = node.arguments&.arguments&.first
384
370
  return unless argument.is_a?(Prism::SymbolNode)
@@ -389,14 +375,14 @@ module RubyLsp
389
375
  find_in_index(constant_name)
390
376
  end
391
377
 
392
- sig { params(value: String).void }
378
+ #: (String value) -> void
393
379
  def find_in_index(value)
394
380
  entries = @index.resolve(value, @node_context.nesting)
395
381
  return unless entries
396
382
 
397
383
  # We should only allow jumping to the definition of private constants if the constant is defined in the same
398
384
  # namespace as the reference
399
- first_entry = T.must(entries.first)
385
+ first_entry = entries.first #: as !nil
400
386
  return if first_entry.private? && first_entry.name != "#{@node_context.fully_qualified_name}::#{value}"
401
387
 
402
388
  entries.each do |entry|