ruby-lsp 0.23.11 → 0.23.12

data/lib/ruby_lsp/listeners/document_symbol.rb

@@ -4,18 +4,11 @@
 module RubyLsp
   module Listeners
     class DocumentSymbol
-      extend T::Sig
       include Requests::Support::Common
 
       ATTR_ACCESSORS = T.let([:attr_reader, :attr_writer, :attr_accessor].freeze, T::Array[Symbol])
 
-      sig do
-        params(
-          response_builder: ResponseBuilders::DocumentSymbol,
-          uri: URI::Generic,
-          dispatcher: Prism::Dispatcher,
-        ).void
-      end
+      #: (ResponseBuilders::DocumentSymbol response_builder, URI::Generic uri, Prism::Dispatcher dispatcher) -> void
       def initialize(response_builder, uri, dispatcher)
         @response_builder = response_builder
         @uri = uri
@@ -52,7 +45,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ClassNode).void }
+      #: (Prism::ClassNode node) -> void
       def on_class_node_enter(node)
         @response_builder << create_document_symbol(
           name: node.constant_path.location.slice,
@@ -62,12 +55,12 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ClassNode).void }
+      #: (Prism::ClassNode node) -> void
       def on_class_node_leave(node)
         @response_builder.pop
       end
 
-      sig { params(node: Prism::SingletonClassNode).void }
+      #: (Prism::SingletonClassNode node) -> void
       def on_singleton_class_node_enter(node)
         expression = node.expression
 
@@ -79,12 +72,12 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::SingletonClassNode).void }
+      #: (Prism::SingletonClassNode node) -> void
       def on_singleton_class_node_leave(node)
         @response_builder.pop
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def on_call_node_enter(node)
         node_name = node.name
         if ATTR_ACCESSORS.include?(node_name)
@@ -98,7 +91,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def on_call_node_leave(node)
         return unless rake?
 
@@ -107,7 +100,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::ConstantPathWriteNode).void }
+      #: (Prism::ConstantPathWriteNode node) -> void
       def on_constant_path_write_node_enter(node)
         create_document_symbol(
           name: node.target.location.slice,
@@ -117,7 +110,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantWriteNode).void }
+      #: (Prism::ConstantWriteNode node) -> void
       def on_constant_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -127,7 +120,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantPathAndWriteNode).void }
+      #: (Prism::ConstantPathAndWriteNode node) -> void
       def on_constant_path_and_write_node_enter(node)
         create_document_symbol(
           name: node.target.location.slice,
@@ -137,7 +130,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantPathOrWriteNode).void }
+      #: (Prism::ConstantPathOrWriteNode node) -> void
       def on_constant_path_or_write_node_enter(node)
         create_document_symbol(
           name: node.target.location.slice,
@@ -147,7 +140,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantPathOperatorWriteNode).void }
+      #: (Prism::ConstantPathOperatorWriteNode node) -> void
       def on_constant_path_operator_write_node_enter(node)
         create_document_symbol(
           name: node.target.location.slice,
@@ -157,7 +150,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantOrWriteNode).void }
+      #: (Prism::ConstantOrWriteNode node) -> void
       def on_constant_or_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -167,7 +160,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantAndWriteNode).void }
+      #: (Prism::ConstantAndWriteNode node) -> void
       def on_constant_and_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -177,7 +170,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantOperatorWriteNode).void }
+      #: (Prism::ConstantOperatorWriteNode node) -> void
       def on_constant_operator_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -187,7 +180,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantTargetNode).void }
+      #: (Prism::ConstantTargetNode node) -> void
       def on_constant_target_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -197,7 +190,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::ConstantPathTargetNode).void }
+      #: (Prism::ConstantPathTargetNode node) -> void
       def on_constant_path_target_node_enter(node)
         create_document_symbol(
           name: node.slice,
@@ -207,12 +200,12 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::DefNode).void }
+      #: (Prism::DefNode node) -> void
       def on_def_node_leave(node)
         @response_builder.pop
       end
 
-      sig { params(node: Prism::ModuleNode).void }
+      #: (Prism::ModuleNode node) -> void
       def on_module_node_enter(node)
         @response_builder << create_document_symbol(
           name: node.constant_path.location.slice,
@@ -222,7 +215,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::DefNode).void }
+      #: (Prism::DefNode node) -> void
       def on_def_node_enter(node)
         receiver = node.receiver
         previous_symbol = @response_builder.last
@@ -248,12 +241,12 @@ module RubyLsp
         @response_builder << symbol
       end
 
-      sig { params(node: Prism::ModuleNode).void }
+      #: (Prism::ModuleNode node) -> void
       def on_module_node_leave(node)
         @response_builder.pop
       end
 
-      sig { params(node: Prism::ClassVariableWriteNode).void }
+      #: (Prism::ClassVariableWriteNode node) -> void
       def on_class_variable_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -263,7 +256,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::InstanceVariableWriteNode).void }
+      #: (Prism::InstanceVariableWriteNode node) -> void
       def on_instance_variable_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -273,7 +266,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::InstanceVariableTargetNode).void }
+      #: (Prism::InstanceVariableTargetNode node) -> void
       def on_instance_variable_target_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -283,7 +276,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::InstanceVariableOperatorWriteNode).void }
+      #: (Prism::InstanceVariableOperatorWriteNode node) -> void
       def on_instance_variable_operator_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -293,7 +286,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::InstanceVariableOrWriteNode).void }
+      #: (Prism::InstanceVariableOrWriteNode node) -> void
       def on_instance_variable_or_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -303,7 +296,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::InstanceVariableAndWriteNode).void }
+      #: (Prism::InstanceVariableAndWriteNode node) -> void
       def on_instance_variable_and_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
@@ -313,7 +306,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::AliasMethodNode).void }
+      #: (Prism::AliasMethodNode node) -> void
       def on_alias_method_node_enter(node)
         new_name_node = node.new_name
         return unless new_name_node.is_a?(Prism::SymbolNode)
@@ -331,14 +324,7 @@ module RubyLsp
 
       private
 
-      sig do
-        params(
-          name: String,
-          kind: Integer,
-          range_location: Prism::Location,
-          selection_range_location: Prism::Location,
-        ).returns(Interface::DocumentSymbol)
-      end
+      #: (name: String, kind: Integer, range_location: Prism::Location, selection_range_location: Prism::Location) -> Interface::DocumentSymbol
       def create_document_symbol(name:, kind:, range_location:, selection_range_location:)
         name = "<blank>" if name.strip.empty?
         symbol = Interface::DocumentSymbol.new(
@@ -354,7 +340,7 @@ module RubyLsp
         symbol
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def handle_attr_accessor(node)
         receiver = node.receiver
         return if receiver && !receiver.is_a?(Prism::SelfNode)
@@ -387,7 +373,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def handle_alias_method(node)
         receiver = node.receiver
         return if receiver && !receiver.is_a?(Prism::SelfNode)
@@ -420,7 +406,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def handle_rake_namespace(node)
         return unless rake?
         return if node.receiver
@@ -446,7 +432,7 @@ module RubyLsp
         )
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def handle_rake_task(node)
         return unless rake?
         return if node.receiver
@@ -481,7 +467,7 @@ module RubyLsp
         )
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def rake?
         if (path = @uri.to_standardized_path)
           path.match?(/(Rakefile|\.rake)$/)

data/lib/ruby_lsp/listeners/folding_ranges.rb

@@ -4,16 +4,9 @@
 module RubyLsp
   module Listeners
     class FoldingRanges
-      extend T::Sig
       include Requests::Support::Common
 
-      sig do
-        params(
-          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::FoldingRange],
-          comments: T::Array[Prism::Comment],
-          dispatcher: Prism::Dispatcher,
-        ).void
-      end
+      #: (ResponseBuilders::CollectionResponseBuilder[Interface::FoldingRange] response_builder, Array[Prism::Comment] comments, Prism::Dispatcher dispatcher) -> void
       def initialize(response_builder, comments, dispatcher)
         @response_builder = response_builder
         @requires = T.let([], T::Array[Prism::CallNode])
@@ -47,33 +40,33 @@ module RubyLsp
         )
       end
 
-      sig { void }
+      #: -> void
       def finalize_response!
         push_comment_ranges
         emit_requires_range
       end
 
-      sig { params(node: Prism::IfNode).void }
+      #: (Prism::IfNode node) -> void
       def on_if_node_enter(node)
         add_statements_range(node)
       end
 
-      sig { params(node: Prism::InNode).void }
+      #: (Prism::InNode node) -> void
       def on_in_node_enter(node)
         add_statements_range(node)
       end
 
-      sig { params(node: Prism::RescueNode).void }
+      #: (Prism::RescueNode node) -> void
       def on_rescue_node_enter(node)
         add_statements_range(node)
       end
 
-      sig { params(node: Prism::WhenNode).void }
+      #: (Prism::WhenNode node) -> void
       def on_when_node_enter(node)
         add_statements_range(node)
       end
 
-      sig { params(node: Prism::InterpolatedStringNode).void }
+      #: (Prism::InterpolatedStringNode node) -> void
       def on_interpolated_string_node_enter(node)
         opening_loc = node.opening_loc || node.location
         closing_loc = node.closing_loc || node.parts.last&.location || node.location
@@ -81,82 +74,82 @@ module RubyLsp
         add_lines_range(opening_loc.start_line, closing_loc.start_line - 1)
       end
 
-      sig { params(node: Prism::ArrayNode).void }
+      #: (Prism::ArrayNode node) -> void
       def on_array_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::BlockNode).void }
+      #: (Prism::BlockNode node) -> void
       def on_block_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::CaseNode).void }
+      #: (Prism::CaseNode node) -> void
       def on_case_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::CaseMatchNode).void }
+      #: (Prism::CaseMatchNode node) -> void
       def on_case_match_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::ClassNode).void }
+      #: (Prism::ClassNode node) -> void
       def on_class_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::ModuleNode).void }
+      #: (Prism::ModuleNode node) -> void
       def on_module_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::ForNode).void }
+      #: (Prism::ForNode node) -> void
       def on_for_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::HashNode).void }
+      #: (Prism::HashNode node) -> void
       def on_hash_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::SingletonClassNode).void }
+      #: (Prism::SingletonClassNode node) -> void
       def on_singleton_class_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::UnlessNode).void }
+      #: (Prism::UnlessNode node) -> void
       def on_unless_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::UntilNode).void }
+      #: (Prism::UntilNode node) -> void
       def on_until_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::WhileNode).void }
+      #: (Prism::WhileNode node) -> void
       def on_while_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::ElseNode).void }
+      #: (Prism::ElseNode node) -> void
       def on_else_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::EnsureNode).void }
+      #: (Prism::EnsureNode node) -> void
       def on_ensure_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::BeginNode).void }
+      #: (Prism::BeginNode node) -> void
       def on_begin_node_enter(node)
         add_simple_range(node)
       end
 
-      sig { params(node: Prism::DefNode).void }
+      #: (Prism::DefNode node) -> void
       def on_def_node_enter(node)
         params = node.parameters
         parameter_loc = params&.location
@@ -171,7 +164,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::CallNode).void }
+      #: (Prism::CallNode node) -> void
       def on_call_node_enter(node)
         # If we find a require, don't visit the child nodes (prevent `super`), so that we can keep accumulating into
         # the `@requires` array and then push the range whenever we find a node that isn't a CallNode
@@ -184,14 +177,14 @@ module RubyLsp
         add_lines_range(location.start_line, location.end_line - 1)
       end
 
-      sig { params(node: Prism::LambdaNode).void }
+      #: (Prism::LambdaNode node) -> void
       def on_lambda_node_enter(node)
         add_simple_range(node)
       end
 
       private
 
-      sig { void }
+      #: -> void
       def push_comment_ranges
         # Group comments that are on consecutive lines and then push ranges for each group that has at least 2 comments
         @comments.chunk_while do |this, other|
@@ -207,7 +200,7 @@ module RubyLsp
         end
       end
 
-      sig { void }
+      #: -> void
       def emit_requires_range
         if @requires.length > 1
           @response_builder << Interface::FoldingRange.new(
@@ -220,7 +213,7 @@ module RubyLsp
         @requires.clear
       end
 
-      sig { params(node: Prism::CallNode).returns(T::Boolean) }
+      #: (Prism::CallNode node) -> bool
       def require?(node)
         message = node.message
         return false unless message == "require" || message == "require_relative"
@@ -234,7 +227,7 @@ module RubyLsp
         arguments.length == 1 && arguments.first.is_a?(Prism::StringNode)
       end
 
-      sig { params(node: T.any(Prism::IfNode, Prism::InNode, Prism::RescueNode, Prism::WhenNode)).void }
+      #: ((Prism::IfNode | Prism::InNode | Prism::RescueNode | Prism::WhenNode) node) -> void
       def add_statements_range(node)
         statements = node.statements
         return unless statements
@@ -245,13 +238,13 @@ module RubyLsp
         add_lines_range(node.location.start_line, statement.location.end_line)
       end
 
-      sig { params(node: Prism::Node).void }
+      #: (Prism::Node node) -> void
       def add_simple_range(node)
         location = node.location
         add_lines_range(location.start_line, location.end_line - 1)
       end
 
-      sig { params(start_line: Integer, end_line: Integer).void }
+      #: (Integer start_line, Integer end_line) -> void
       def add_lines_range(start_line, end_line)
         emit_requires_range
         return if start_line >= end_line