ruby-lsp 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9762389a7b7979afb57d6e6d2cf0d65b0b0a0b31f5a1fdd7045311c33a0c21d6
-  data.tar.gz: 35cc2318946e650ee311129955d3674c7e693a87d25c5cc2f29c5a55e479d880
+  metadata.gz: 62174da68ba92c0af61878221168a02398c9b3df2867b63c063850b1787c7104
+  data.tar.gz: dc3d2e17e3fe2dcbb6578902eb3b672babc72d0f10511c021db767cfde709b0b
 SHA512:
-  metadata.gz: 4735e18c297c992727d0a151ed7948cf6d4ea32b01fe411ed0774efdda7cdc0cf6533f5d71ad288aad9e6e717149932744376fdceda9fa4cd039b560934a9b47
-  data.tar.gz: bd6e0c9a81a373c509f2f96b480543657a8d241a6e58ea25ec21c62ac60094f299af1c5f85d1555ad6ca1908c325e46569119271d4c6b7117f33f9919cf40bca
+  metadata.gz: c8295ce6739f9452dd20cab22ebb19fb099040f4782afa4dfd63b423b08ad73eedeb1fccc33113dcd7b27d38745e7112a6d272ea28652e00102a870c18c51b96
+  data.tar.gz: 1e1a2a681dcdf97bbb1f667211111b89ca274c1d89745bcd3cf8511fbc3d41416d0bb5a45f2fcaf85feb8b0469a5441b5500148136f849657d263531ffe5ff8a

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.3

data/lib/ruby_lsp/document.rb

@@ -38,7 +38,7 @@ module RubyLsp
       type_parameters(:T)
         .params(
           request_name: Symbol,
-          block: T.proc.params(document: Document).returns(T.type_parameter(:T))
+          block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
         ).returns(T.type_parameter(:T))
     end
     def cache_fetch(request_name, &block)

data/lib/ruby_lsp/handler.rb

@@ -26,7 +26,7 @@ module RubyLsp
       # for displaying window messages on errors
       sig do
         params(
-          block: T.proc.bind(Handler).params(error: Exception, request: T::Hash[Symbol, T.untyped]).void
+          block: T.proc.bind(Handler).params(error: Exception, request: T::Hash[Symbol, T.untyped]).void,
         ).void
       end
       def on_error(&block)
@@ -85,7 +85,7 @@ module RubyLsp
       params(
         msg: String,
         parallel: T::Boolean,
-        blk: T.proc.bind(Handler).params(request: T::Hash[Symbol, T.untyped]).returns(T.untyped)
+        blk: T.proc.bind(Handler).params(request: T::Hash[Symbol, T.untyped]).returns(T.untyped),
       ).returns(RequestHandler)
     end
     def on(msg, parallel: false, &blk)
@@ -103,7 +103,7 @@ module RubyLsp
     def clear_diagnostics(uri)
       @writer.write(
         method: "textDocument/publishDiagnostics",
-        params: Interface::PublishDiagnosticsParams.new(uri: uri, diagnostics: [])
+        params: Interface::PublishDiagnosticsParams.new(uri: uri, diagnostics: []),
       )
     end
 
@@ -111,7 +111,7 @@ module RubyLsp
     def show_message(type, message)
       @writer.write(
         method: "window/showMessage",
-        params: Interface::ShowMessageParams.new(type: type, message: message)
+        params: Interface::ShowMessageParams.new(type: type, message: message),
       )
     end
   end

data/lib/ruby_lsp/queue.rb

@@ -7,8 +7,6 @@ module RubyLsp
   class Queue
     extend T::Sig
 
-    class Cancelled < StandardError; end
-
     class Result < T::Struct
       const :response, T.untyped # rubocop:disable Sorbet/ForbidUntypedStructProps
       const :error, T.nilable(Exception)
@@ -30,7 +28,7 @@ module RubyLsp
     sig do
       params(
         writer: LanguageServer::Protocol::Transport::Stdio::Writer,
-        handlers: T::Hash[String, Handler::RequestHandler]
+        handlers: T::Hash[String, Handler::RequestHandler],
       ).void
     end
     def initialize(writer, handlers)
@@ -40,8 +38,6 @@ module RubyLsp
       @job_queue = T.let(Thread::Queue.new, Thread::Queue)
       # The jobs hash is just a way of keeping a handle to jobs based on the request ID, so we can cancel them
       @jobs = T.let({}, T::Hash[T.any(String, Integer), Job])
-      # The current job is a handle to cancel jobs that are currently being processed
-      @current_job = T.let(nil, T.nilable(Job))
       @mutex = T.let(Mutex.new, Mutex)
       @worker = T.let(new_worker, Thread)
 
@@ -65,11 +61,6 @@ module RubyLsp
       @mutex.synchronize do
         # Cancel the job if it's still in the queue
         @jobs[id]&.cancel
-
-        # Cancel the job if we're in the middle of processing it
-        if @current_job&.request&.dig(:id) == id
-          @worker.raise(Cancelled)
-        end
       end
     end
 
@@ -92,8 +83,6 @@ module RubyLsp
 
       request_time = Benchmark.realtime do
         response = T.must(@handlers[request[:method]]).action.call(request)
-      rescue Cancelled
-        raise
       rescue StandardError, LoadError => e
         error = e
       end
@@ -105,29 +94,31 @@ module RubyLsp
     sig do
       params(
         result: Result,
-        request: T::Hash[Symbol, T.untyped]
+        request: T::Hash[Symbol, T.untyped],
       ).void
     end
     def finalize_request(result, request)
-      error = result.error
-      if error
-        T.must(@handlers[request[:method]]).error_handler&.call(error, request)
-
-        @writer.write(
-          id: request[:id],
-          error: {
-            code: LanguageServer::Protocol::Constant::ErrorCodes::INTERNAL_ERROR,
-            message: result.error.inspect,
-            data: request.to_json,
-          },
-        )
-      elsif result.response != Handler::VOID
-        @writer.write(id: request[:id], result: result.response)
-      end
+      @mutex.synchronize do
+        error = result.error
+        if error
+          T.must(@handlers[request[:method]]).error_handler&.call(error, request)
+
+          @writer.write(
+            id: request[:id],
+            error: {
+              code: LanguageServer::Protocol::Constant::ErrorCodes::INTERNAL_ERROR,
+              message: error.inspect,
+              data: request.to_json,
+            },
+          )
+        elsif result.response != Handler::VOID
+          @writer.write(id: request[:id], result: result.response)
+        end
 
-      request_time = result.request_time
-      if request_time
-        @writer.write(method: "telemetry/event", params: telemetry_params(request, request_time, result.error))
+        request_time = result.request_time
+        if request_time
+          @writer.write(method: "telemetry/event", params: telemetry_params(request, request_time, error))
+        end
       end
     end
 
@@ -139,28 +130,20 @@ module RubyLsp
         # Thread::Queue#pop is thread safe and will wait until an item is available
         loop do
           job = T.let(@job_queue.pop, T.nilable(Job))
-          break if job.nil?
-
           # The only time when the job is nil is when the queue is closed and we can then terminate the thread
+          break if job.nil?
 
           request = job.request
-          @mutex.synchronize do
-            @jobs.delete(request[:id])
-            @current_job = job
-          end
+          @mutex.synchronize { @jobs.delete(request[:id]) }
 
-          next if job.cancelled
-
-          result = execute(request)
-        rescue Cancelled
-          # We need to return nil to the client even if the request was cancelled
-          result = Queue::Result.new(response: nil, error: nil, request_time: nil)
-        ensure
-          @mutex.synchronize { @current_job = nil }
+          result = if job.cancelled
+            # We need to return nil to the client even if the request was cancelled
+            Queue::Result.new(response: nil, error: nil, request_time: nil)
+          else
+            execute(request)
+          end
 
-          # If there's request, it means the worker was cancelled while waiting to pop from the queue or immediately
-          # after
-          finalize_request(result, request) unless result.nil? || request.nil?
+          finalize_request(result, request)
         end
       end
     end
@@ -169,7 +152,7 @@ module RubyLsp
       params(
         request: T::Hash[Symbol, T.untyped],
         request_time: Float,
-        error: T.nilable(Exception)
+        error: T.nilable(Exception),
       ).returns(T::Hash[Symbol, T.any(String, Float)])
     end
     def telemetry_params(request, request_time, error)
@@ -184,6 +167,12 @@ module RubyLsp
       if error
         params[:errorClass] = error.class.name
         params[:errorMessage] = error.message
+
+        log_params = request[:params]&.reject { |k, _| k == :textDocument }
+        params[:params] = log_params.to_json if log_params&.any?
+
+        backtrace = error.backtrace
+        params[:backtrace] = backtrace.map { |bt| bt.sub(/^#{Dir.home}/, "~") }.join("\n") if backtrace
       end
 
       params[:uri] = uri.sub(%r{.*://#{Dir.home}}, "~") if uri

data/lib/ruby_lsp/requests/code_actions.rb

@@ -23,7 +23,7 @@ module RubyLsp
         params(
           uri: String,
           document: Document,
-          range: T::Range[Integer]
+          range: T::Range[Integer],
         ).void
       end
       def initialize(uri, document, range)

data/lib/ruby_lsp/requests/diagnostics.rb

@@ -33,7 +33,7 @@ module RubyLsp
           T.any(
             T.all(T::Array[Support::RuboCopDiagnostic], Object),
             T.all(T::Array[Support::SyntaxErrorDiagnostic], Object),
-          )
+          ),
         )
       end
       def run

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -43,7 +43,7 @@ module RubyLsp
         @highlights
       end
 
-      sig { params(node: T.nilable(SyntaxTree::Node)).void }
+      sig { override.params(node: T.nilable(SyntaxTree::Node)).void }
       def visit(node)
         return if node.nil?
 

data/lib/ruby_lsp/requests/document_link.rb

@@ -25,7 +25,7 @@ module RubyLsp
         [*::Gem::Specification.default_stubs, *::Gem::Specification.stubs].map! do |s|
           [s.name, s.version.to_s]
         end.to_h.freeze,
-        T::Hash[String, String]
+        T::Hash[String, String],
       )
 
       class << self
@@ -82,7 +82,7 @@ module RubyLsp
         @links
       end
 
-      sig { params(node: SyntaxTree::Comment).void }
+      sig { override.params(node: SyntaxTree::Comment).void }
       def visit_comment(node)
         match = node.value.match(%r{source://.*#\d+$})
         return unless match
@@ -95,7 +95,7 @@ module RubyLsp
         @links << LanguageServer::Protocol::Interface::DocumentLink.new(
           range: range_from_syntax_tree_node(node),
           target: "file://#{file_path}##{uri.line_number}",
-          tooltip: "Jump to #{file_path}##{uri.line_number}"
+          tooltip: "Jump to #{file_path}##{uri.line_number}",
         )
       end
 

data/lib/ruby_lsp/requests/document_symbol.rb

@@ -79,7 +79,7 @@ module RubyLsp
         @root = T.let(SymbolHierarchyRoot.new, SymbolHierarchyRoot)
         @stack = T.let(
           [@root],
-          T::Array[T.any(SymbolHierarchyRoot, LanguageServer::Protocol::Interface::DocumentSymbol)]
+          T::Array[T.any(SymbolHierarchyRoot, LanguageServer::Protocol::Interface::DocumentSymbol)],
         )
       end
 
@@ -89,13 +89,13 @@ module RubyLsp
         @root.children
       end
 
-      sig { params(node: SyntaxTree::ClassDeclaration).void }
+      sig { override.params(node: SyntaxTree::ClassDeclaration).void }
       def visit_class(node)
         symbol = create_document_symbol(
           name: fully_qualified_name(node),
           kind: :class,
           range_node: node,
-          selection_range_node: node.constant
+          selection_range_node: node.constant,
         )
 
         @stack << symbol
@@ -103,7 +103,7 @@ module RubyLsp
         @stack.pop
       end
 
-      sig { params(node: SyntaxTree::Command).void }
+      sig { override.params(node: SyntaxTree::Command).void }
       def visit_command(node)
         return unless ATTR_ACCESSORS.include?(node.message.value)
 
@@ -114,22 +114,22 @@ module RubyLsp
             name: argument.value.value,
             kind: :field,
             range_node: argument,
-            selection_range_node: argument.value
+            selection_range_node: argument.value,
           )
         end
       end
 
-      sig { params(node: SyntaxTree::ConstPathField).void }
+      sig { override.params(node: SyntaxTree::ConstPathField).void }
       def visit_const_path_field(node)
         create_document_symbol(
           name: node.constant.value,
           kind: :constant,
           range_node: node,
-          selection_range_node: node.constant
+          selection_range_node: node.constant,
         )
       end
 
-      sig { params(node: SyntaxTree::Def).void }
+      sig { override.params(node: SyntaxTree::Def).void }
       def visit_def(node)
         name = node.name.value
 
@@ -137,7 +137,7 @@ module RubyLsp
           name: name,
           kind: name == "initialize" ? :constructor : :method,
           range_node: node,
-          selection_range_node: node.name
+          selection_range_node: node.name,
         )
 
         @stack << symbol
@@ -145,7 +145,7 @@ module RubyLsp
         @stack.pop
       end
 
-      sig { params(node: SyntaxTree::DefEndless).void }
+      sig { override.params(node: SyntaxTree::DefEndless).void }
       def visit_def_endless(node)
         name = node.name.value
 
@@ -153,7 +153,7 @@ module RubyLsp
           name: name,
           kind: name == "initialize" ? :constructor : :method,
           range_node: node,
-          selection_range_node: node.name
+          selection_range_node: node.name,
         )
 
         @stack << symbol
@@ -161,13 +161,13 @@ module RubyLsp
         @stack.pop
       end
 
-      sig { params(node: SyntaxTree::Defs).void }
+      sig { override.params(node: SyntaxTree::Defs).void }
       def visit_defs(node)
         symbol = create_document_symbol(
           name: "self.#{node.name.value}",
           kind: :method,
           range_node: node,
-          selection_range_node: node.name
+          selection_range_node: node.name,
         )
 
         @stack << symbol
@@ -175,13 +175,13 @@ module RubyLsp
         @stack.pop
       end
 
-      sig { params(node: SyntaxTree::ModuleDeclaration).void }
+      sig { override.params(node: SyntaxTree::ModuleDeclaration).void }
       def visit_module(node)
         symbol = create_document_symbol(
           name: fully_qualified_name(node),
           kind: :module,
           range_node: node,
-          selection_range_node: node.constant
+          selection_range_node: node.constant,
         )
 
         @stack << symbol
@@ -189,17 +189,17 @@ module RubyLsp
         @stack.pop
       end
 
-      sig { params(node: SyntaxTree::TopConstField).void }
+      sig { override.params(node: SyntaxTree::TopConstField).void }
       def visit_top_const_field(node)
         create_document_symbol(
           name: node.constant.value,
           kind: :constant,
           range_node: node,
-          selection_range_node: node.constant
+          selection_range_node: node.constant,
         )
       end
 
-      sig { params(node: SyntaxTree::VarField).void }
+      sig { override.params(node: SyntaxTree::VarField).void }
       def visit_var_field(node)
         kind = case node.value
         when SyntaxTree::Const
@@ -214,7 +214,7 @@ module RubyLsp
           name: node.value.value,
           kind: kind,
           range_node: node,
-          selection_range_node: node.value
+          selection_range_node: node.value,
         )
       end
 
@@ -225,7 +225,7 @@ module RubyLsp
           name: String,
           kind: Symbol,
           range_node: SyntaxTree::Node,
-          selection_range_node: SyntaxTree::Node
+          selection_range_node: SyntaxTree::Node,
         ).returns(LanguageServer::Protocol::Interface::DocumentSymbol)
       end
       def create_document_symbol(name:, kind:, range_node:, selection_range_node:)

data/lib/ruby_lsp/requests/folding_ranges.rb

@@ -73,7 +73,7 @@ module RubyLsp
 
       private
 
-      sig { params(node: T.nilable(SyntaxTree::Node)).void }
+      sig { override.params(node: T.nilable(SyntaxTree::Node)).void }
       def visit(node)
         return unless handle_partial_range(node)
 
@@ -137,7 +137,7 @@ module RubyLsp
           LanguageServer::Protocol::Interface::FoldingRange.new(
             start_line: @start_line,
             end_line: @end_line,
-            kind: @kind
+            kind: @kind,
           )
         end
 
@@ -248,7 +248,7 @@ module RubyLsp
         @ranges << LanguageServer::Protocol::Interface::FoldingRange.new(
           start_line: start_line - 1,
           end_line: end_line - 1,
-          kind: "region"
+          kind: "region",
         )
       end
     end

data/lib/ruby_lsp/requests/formatting.rb

@@ -42,9 +42,9 @@ module RubyLsp
           LanguageServer::Protocol::Interface::TextEdit.new(
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(line: 0, character: 0),
-              end: LanguageServer::Protocol::Interface::Position.new(line: size, character: size)
+              end: LanguageServer::Protocol::Interface::Position.new(line: size, character: size),
             ),
-            new_text: formatted_text
+            new_text: formatted_text,
           ),
         ]
       end

data/lib/ruby_lsp/requests/inlay_hints.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Inlay hint demo](../../misc/inlay_hint.gif)
+    #
+    # [Inlay hints](https://microsoft.github.io/language-server-protocol/specification#textDocument_inlayHint)
+    # are labels added directly in the code that explicitly show the user something that might
+    # otherwise just be implied.
+    #
+    # # Example
+    #
+    # ```ruby
+    # begin
+    #   puts "do something that might raise"
+    # rescue # Label "StandardError" goes here as a bare rescue implies rescuing StandardError
+    #   puts "handle some rescue"
+    # end
+    # ```
+    class InlayHints < BaseRequest
+      RESCUE_STRING_LENGTH = T.let("rescue".length, Integer)
+
+      sig { params(document: Document, range: T::Range[Integer]).void }
+      def initialize(document, range)
+        super(document)
+
+        @hints = T.let([], T::Array[LanguageServer::Protocol::Interface::InlayHint])
+        @range = range
+      end
+
+      sig { override.returns(T.all(T::Array[LanguageServer::Protocol::Interface::InlayHint], Object)) }
+      def run
+        visit(@document.tree)
+        @hints
+      end
+
+      sig { override.params(node: SyntaxTree::Rescue).void }
+      def visit_rescue(node)
+        return unless node.exception.nil?
+
+        loc = node.location
+        return unless @range.cover?(loc.start_line - 1) && @range.cover?(loc.end_line - 1)
+
+        @hints << LanguageServer::Protocol::Interface::InlayHint.new(
+          position: { line: loc.start_line - 1, character: loc.start_column + RESCUE_STRING_LENGTH },
+          label: "StandardError",
+          padding_left: true,
+          tooltip: "StandardError is implied in a bare rescue",
+        )
+
+        super
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -101,15 +101,15 @@ module RubyLsp
       def add_edit_with_text(text)
         position = Interface::Position.new(
           line: @position[:line],
-          character: @position[:character]
+          character: @position[:character],
         )
 
         @edits << Interface::TextEdit.new(
           range: Interface::Range.new(
             start: position,
-            end: position
+            end: position,
           ),
-          new_text: text
+          new_text: text,
         )
       end
 
@@ -117,7 +117,7 @@ module RubyLsp
       def move_cursor_to(line, character)
         position = Interface::Position.new(
           line: line,
-          character: character
+          character: character,
         )
 
         # The $0 is a special snippet anchor that moves the cursor to that given position. See the snippets
@@ -126,9 +126,9 @@ module RubyLsp
         @edits << Interface::TextEdit.new(
           range: Interface::Range.new(
             start: position,
-            end: position
+            end: position,
           ),
-          new_text: "$0"
+          new_text: "$0",
         )
       end
 

data/lib/ruby_lsp/requests/selection_ranges.rb

@@ -76,7 +76,7 @@ module RubyLsp
 
       private
 
-      sig { params(node: T.nilable(SyntaxTree::Node)).void }
+      sig { override.params(node: T.nilable(SyntaxTree::Node)).void }
       def visit(node)
         return if node.nil?
 
@@ -93,7 +93,7 @@ module RubyLsp
       sig do
         params(
           location: SyntaxTree::Location,
-          parent: T.nilable(Support::SelectionRange)
+          parent: T.nilable(Support::SelectionRange),
         ).returns(Support::SelectionRange)
       end
       def create_selection_range(location, parent = nil)
@@ -108,7 +108,7 @@ module RubyLsp
               character: location.end_column,
             ),
           ),
-          parent: parent
+          parent: parent,
         )
       end
     end

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -90,7 +90,7 @@ module RubyLsp
           T.any(
             LanguageServer::Protocol::Interface::SemanticTokens,
             T.all(T::Array[SemanticToken], Object),
-          )
+          ),
         )
       end
       def run
@@ -100,12 +100,7 @@ module RubyLsp
         @encoder.encode(@tokens)
       end
 
-      sig { params(node: SyntaxTree::ARefField).void }
-      def visit_a_ref_field(node)
-        add_token(node.collection.value.location, :variable)
-      end
-
-      sig { params(node: SyntaxTree::Call).void }
+      sig { override.params(node: SyntaxTree::Call).void }
       def visit_call(node)
         visit(node.receiver)
 
@@ -115,32 +110,32 @@ module RubyLsp
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Command).void }
+      sig { override.params(node: SyntaxTree::Command).void }
       def visit_command(node)
         add_token(node.message.location, :method) unless special_method?(node.message.value)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::CommandCall).void }
+      sig { override.params(node: SyntaxTree::CommandCall).void }
       def visit_command_call(node)
         visit(node.receiver)
         add_token(node.message.location, :method)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Const).void }
+      sig { override.params(node: SyntaxTree::Const).void }
       def visit_const(node)
         add_token(node.location, :namespace)
       end
 
-      sig { params(node: SyntaxTree::Def).void }
+      sig { override.params(node: SyntaxTree::Def).void }
       def visit_def(node)
         add_token(node.name.location, :method, [:declaration])
         visit(node.params)
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::DefEndless).void }
+      sig { override.params(node: SyntaxTree::DefEndless).void }
       def visit_def_endless(node)
         add_token(node.name.location, :method, [:declaration])
         visit(node.paren)
@@ -148,7 +143,7 @@ module RubyLsp
         visit(node.statement)
       end
 
-      sig { params(node: SyntaxTree::Defs).void }
+      sig { override.params(node: SyntaxTree::Defs).void }
       def visit_defs(node)
         visit(node.target)
         visit(node.operator)
@@ -157,13 +152,13 @@ module RubyLsp
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::FCall).void }
+      sig { override.params(node: SyntaxTree::FCall).void }
       def visit_fcall(node)
         add_token(node.value.location, :method) unless special_method?(node.value.value)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Kw).void }
+      sig { override.params(node: SyntaxTree::Kw).void }
       def visit_kw(node)
         case node.value
         when "self"
@@ -171,14 +166,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::MAssign).void }
-      def visit_m_assign(node)
-        node.target.parts.each do |var_ref|
-          add_token(var_ref.value.location, :variable)
-        end
-      end
-
-      sig { params(node: SyntaxTree::Params).void }
+      sig { override.params(node: SyntaxTree::Params).void }
       def visit_params(node)
         node.keywords.each do |keyword,|
           location = keyword.location
@@ -196,7 +184,7 @@ module RubyLsp
         add_token(name.location, :variable) if name
       end
 
-      sig { params(node: SyntaxTree::VarField).void }
+      sig { override.params(node: SyntaxTree::VarField).void }
       def visit_var_field(node)
         case node.value
         when SyntaxTree::Ident
@@ -206,7 +194,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::VarRef).void }
+      sig { override.params(node: SyntaxTree::VarRef).void }
       def visit_var_ref(node)
         case node.value
         when SyntaxTree::Ident
@@ -216,19 +204,19 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::VCall).void }
+      sig { override.params(node: SyntaxTree::VCall).void }
       def visit_vcall(node)
         add_token(node.value.location, :method) unless special_method?(node.value.value)
       end
 
-      sig { params(node: SyntaxTree::ClassDeclaration).void }
+      sig { override.params(node: SyntaxTree::ClassDeclaration).void }
       def visit_class(node)
         add_token(node.constant.location, :class, [:declaration])
         add_token(node.superclass.location, :class) if node.superclass
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::ModuleDeclaration).void }
+      sig { override.params(node: SyntaxTree::ModuleDeclaration).void }
       def visit_module(node)
         add_token(node.constant.location, :class, [:declaration])
         visit(node.bodystmt)
@@ -243,8 +231,8 @@ module RubyLsp
             location: location,
             length: length,
             type: T.must(TOKEN_TYPES[type]),
-            modifier: modifiers_indices
-          )
+            modifier: modifiers_indices,
+          ),
         )
       end
 

data/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb

@@ -25,7 +25,7 @@ module RubyLsp
           @uri = uri
           @replacements = T.let(
             offense.correctable? ? offense_replacements : [],
-            T::Array[LanguageServer::Protocol::Interface::TextEdit]
+            T::Array[LanguageServer::Protocol::Interface::TextEdit],
           )
         end
 
@@ -49,11 +49,11 @@ module RubyLsp
                 LanguageServer::Protocol::Interface::TextDocumentEdit.new(
                   text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
                     uri: @uri,
-                    version: nil
+                    version: nil,
                   ),
-                  edits: @replacements
+                  edits: @replacements,
                 ),
-              ]
+              ],
             ),
             is_preferred: true,
           )
@@ -76,13 +76,13 @@ module RubyLsp
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(
                 line: @offense.line - 1,
-                character: @offense.column
+                character: @offense.column,
               ),
               end: LanguageServer::Protocol::Interface::Position.new(
                 line: @offense.last_line - 1,
-                character: @offense.last_column
-              )
-            )
+                character: @offense.last_column,
+              ),
+            ),
           )
         end
 
@@ -95,9 +95,9 @@ module RubyLsp
               range: LanguageServer::Protocol::Interface::Range.new(
                 start: LanguageServer::Protocol::Interface::Position.new(line: range.line - 1, character: range.column),
                 end: LanguageServer::Protocol::Interface::Position.new(line: range.last_line - 1,
-                  character: range.last_column)
+                  character: range.last_column),
               ),
-              new_text: replacement
+              new_text: replacement,
             )
           end
         end

data/lib/ruby_lsp/requests/support/rubocop_runner.rb

@@ -7,6 +7,12 @@ rescue LoadError
   return
 end
 
+begin
+  gem("rubocop", ">= 1.4.0")
+rescue LoadError
+  raise StandardError, "Incompatible RuboCop version. Ruby LSP requires >= 1.4.0"
+end
+
 module RubyLsp
   module Requests
     module Support
@@ -14,6 +20,8 @@ module RubyLsp
       class RuboCopRunner < RuboCop::Runner
         extend T::Sig
 
+        class ConfigurationError < StandardError; end
+
         sig { returns(T::Array[RuboCop::Cop::Offense]) }
         attr_reader :offenses
 
@@ -50,6 +58,8 @@ module RubyLsp
           super([path])
         rescue RuboCop::Runner::InfiniteCorrectionLoop => error
           raise Formatting::Error, error.message
+        rescue RuboCop::ValidationError => error
+          raise ConfigurationError, error.message
         end
 
         sig { returns(String) }

data/lib/ruby_lsp/requests/support/semantic_token_encoder.rb

@@ -15,7 +15,7 @@ module RubyLsp
 
         sig do
           params(
-            tokens: T::Array[SemanticHighlighting::SemanticToken]
+            tokens: T::Array[SemanticHighlighting::SemanticToken],
           ).returns(LanguageServer::Protocol::Interface::SemanticTokens)
         end
         def encode(tokens)

data/lib/ruby_lsp/requests/support/source_uri.rb

@@ -30,7 +30,7 @@ module URI
           gem_name: String,
           gem_version: T.nilable(String),
           path: String,
-          line_number: T.nilable(String)
+          line_number: T.nilable(String),
         ).returns(URI::Source)
       end
       def build(gem_name:, gem_version:, path:, line_number:)

data/lib/ruby_lsp/requests/support/syntax_error_diagnostic.rb

@@ -23,7 +23,7 @@ module RubyLsp
             message: "Syntax error",
             source: "SyntaxTree",
             severity: LanguageServer::Protocol::Constant::DiagnosticSeverity::ERROR,
-            range: @edit[:range]
+            range: @edit[:range],
           )
         end
       end

data/lib/ruby_lsp/requests.rb

@@ -14,6 +14,8 @@ module RubyLsp
   # - {RubyLsp::Requests::Diagnostics}
   # - {RubyLsp::Requests::CodeActions}
   # - {RubyLsp::Requests::DocumentHighlight}
+  # - {RubyLsp::Requests::InlayHints}
+
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
     autoload :DocumentSymbol, "ruby_lsp/requests/document_symbol"
@@ -26,6 +28,7 @@ module RubyLsp
     autoload :Diagnostics, "ruby_lsp/requests/diagnostics"
     autoload :CodeActions, "ruby_lsp/requests/code_actions"
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
+    autoload :InlayHints, "ruby_lsp/requests/inlay_hints"
 
     # :nodoc:
     module Support

data/lib/ruby_lsp/server.rb

@@ -15,7 +15,7 @@ module RubyLsp
           hierarchical_document_symbol_support: true,
           symbol_kind: {
             value_set: Requests::DocumentSymbol::SYMBOL_KIND.values,
-          }
+          },
         )
       end
 
@@ -32,12 +32,12 @@ module RubyLsp
           document_selector: { scheme: "file", language: "ruby" },
           legend: Interface::SemanticTokensLegend.new(
             token_types: Requests::SemanticHighlighting::TOKEN_TYPES.keys,
-            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys
+            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys,
           ),
           range: false,
           full: {
             delta: true,
-          }
+          },
         )
       end
 
@@ -51,10 +51,14 @@ module RubyLsp
       on_type_formatting_provider = if enabled_features.include?("onTypeFormatting")
         Interface::DocumentOnTypeFormattingOptions.new(
           first_trigger_character: "{",
-          more_trigger_character: ["\n", "|"]
+          more_trigger_character: ["\n", "|"],
         )
       end
 
+      inlay_hint_provider = if enabled_features.include?("inlayHint")
+        Interface::InlayHintOptions.new(resolve_provider: false)
+      end
+
       Interface::InitializeResult.new(
         capabilities: Interface::ServerCapabilities.new(
           text_document_sync: Interface::TextDocumentSyncOptions.new(
@@ -71,7 +75,8 @@ module RubyLsp
           code_action_provider: enabled_features.include?("codeActions"),
           document_on_type_formatting_provider: on_type_formatting_provider,
           diagnostic_provider: diagnostics_provider,
-        )
+          inlay_hint_provider: inlay_hint_provider,
+        ),
       )
     end
 
@@ -144,9 +149,9 @@ module RubyLsp
         T.cast(
           Requests::SemanticHighlighting.new(
             document,
-            encoder: Requests::Support::SemanticTokenEncoder.new
+            encoder: Requests::Support::SemanticTokenEncoder.new,
           ).run,
-          LanguageServer::Protocol::Interface::SemanticTokens
+          LanguageServer::Protocol::Interface::SemanticTokens,
         )
       end
     end
@@ -186,12 +191,23 @@ module RubyLsp
       end
     end
 
+    on("textDocument/inlayHint", parallel: true) do |request|
+      document = store.get(request.dig(:params, :textDocument, :uri))
+      range = request.dig(:params, :range)
+      start_line = range.dig(:start, :line)
+      end_line = range.dig(:end, :line)
+
+      if document.parsed?
+        Requests::InlayHints.new(document, start_line..end_line).run
+      end
+    end
+
     on("$/cancelRequest") do |request|
       cancel_request(request[:params][:id])
       Handler::VOID
     end
 
-    on("textDocument/diagnostic") do |request|
+    on("textDocument/diagnostic", parallel: true) do |request|
       uri = request.dig(:params, :textDocument, :uri)
       response = store.cache_fetch(uri, :diagnostics) do |document|
         Requests::Diagnostics.new(uri, document).run
@@ -199,9 +215,7 @@ module RubyLsp
 
       { kind: "full", items: response.map(&:to_lsp_diagnostic) } if response
     end.on_error do |error|
-      if error.is_a?(RuboCop::ValidationError)
-        show_message(Constant::MessageType::ERROR, "Error in RuboCop configuration file: #{error.message}")
-      end
+      show_message(Constant::MessageType::ERROR, "Error running diagnostics: #{error.message}")
     end
 
     on("shutdown") { shutdown }

data/lib/ruby_lsp/store.rb

@@ -54,7 +54,7 @@ module RubyLsp
         .params(
           uri: String,
           request_name: Symbol,
-          block: T.proc.params(document: Document).returns(T.type_parameter(:T))
+          block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
         ).returns(T.nilable(T.type_parameter(:T)))
     end
     def cache_fetch(uri, request_name, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -60,7 +60,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - VERSION
@@ -79,6 +78,7 @@ files:
 - lib/ruby_lsp/requests/document_symbol.rb
 - lib/ruby_lsp/requests/folding_ranges.rb
 - lib/ruby_lsp/requests/formatting.rb
+- lib/ruby_lsp/requests/inlay_hints.rb
 - lib/ruby_lsp/requests/on_type_formatting.rb
 - lib/ruby_lsp/requests/selection_ranges.rb
 - lib/ruby_lsp/requests/semantic_highlighting.rb

data/CHANGELOG.md

@@ -1,70 +0,0 @@
-# Change Log
-
-All notable changes to the "ruby-lsp" extension will be documented in this file.
-
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
-
-## [Unreleased]
-
-## [0.3.1]
-
-- Resolve TODO for LSP v3.17 (https://github.com/Shopify/ruby-lsp/pull/268)
-- Add dependency constraint for LSP v3.17 (https://github.com/Shopify/ruby-lsp/pull/269)
-- Handle class/module declarations as a class token with declaration modifier (https://github.com/Shopify/ruby-lsp/pull/260)
-- Handle required parameters in semantic highlighting (https://github.com/Shopify/ruby-lsp/pull/271)
-- Add comment continuation via on type on_type_formatting (https://github.com/Shopify/ruby-lsp/pull/274)
-- Make RuboCop runner use composition instead of inheritance (https://github.com/Shopify/ruby-lsp/pull/278)
-- Protect worker against cancellation during popping (https://github.com/Shopify/ruby-lsp/pull/280)
-- Handle formatting errors in on_error block (https://github.com/Shopify/ruby-lsp/pull/279)
-- Fix on type formatting pipe completion for regular or expressions (https://github.com/Shopify/ruby-lsp/pull/282)
-- Do not fail on LoadError (https://github.com/Shopify/ruby-lsp/pull/292)
-
-## [0.3.0]
-- Add on type formatting completions (https://github.com/Shopify/ruby-lsp/pull/253)
-- Upgrade syntax_tree requirement to >= 3.4 (https://github.com/Shopify/ruby-lsp/pull/254)
-- Show error message when there's a InfiniteCorrectionLoop exception (https://github.com/Shopify/ruby-lsp/pull/252)
-- Add request cancellation (https://github.com/Shopify/ruby-lsp/pull/243)
-
-## [0.2.0]
-
-- Add semantic token for keyword and keyword rest params (https://github.com/Shopify/ruby-lsp/pull/142)
-- Return error responses on exceptions (https://github.com/Shopify/ruby-lsp/pull/160)
-- Sanitize home directory for telemetry (https://github.com/Shopify/ruby-lsp/pull/171)
-- Avoid adding semantic tokens for special methods (https://github.com/Shopify/ruby-lsp/pull/162)
-- Properly respect excluded files in RuboCop requests (https://github.com/Shopify/ruby-lsp/pull/173)
-- Clear diagnostics when closing files (https://github.com/Shopify/ruby-lsp/pull/174)
-- Avoid pushing ranges for single line partial ranges (https://github.com/Shopify/ruby-lsp/pull/185)
-- Change folding ranges to include closing tokens (https://github.com/Shopify/ruby-lsp/pull/181)
-- Remove RuboCop dependency and fallback to SyntaxTree formatting (https://github.com/Shopify/ruby-lsp/pull/184)
-
-## [0.1.0]
-
-- Implement token modifiers in SemanticTokenEncoder ([#112](https://github.com/Shopify/ruby-lsp/pull/112))
-- Add semantic token for name in a method definition ([#133](https://github.com/Shopify/ruby-lsp/pull/133))
-- Add semantic highighting for def endless and singleton method names ([#134](https://github.com/Shopify/ruby-lsp/pull/134))
-- Add semantic token for keyword self ([#137](https://github.com/Shopify/ruby-lsp/pull/137))
-- Add semantic token for constants ([#138](https://github.com/Shopify/ruby-lsp/pull/138))
-- Improve error handling + fix formatting hanging issue ([#149](https://github.com/Shopify/ruby-lsp/pull/149))
-- Set the minimum syntax_tree version to 2.4 ([#151](https://github.com/Shopify/ruby-lsp/pull/151))
-
-## [0.0.4]
-
-- Add basic document highlight (https://github.com/Shopify/ruby-lsp/pull/91)
-- Add error telemetry (https://github.com/Shopify/ruby-lsp/pull/100)
-- Always push telemetry events from the server (https://github.com/Shopify/ruby-lsp/pull/109)
-- Fix multibyte character handling (https://github.com/Shopify/ruby-lsp/pull/122)
-- Add Sorbet to the Ruby LSP (https://github.com/Shopify/ruby-lsp/pull/119, https://github.com/Shopify/ruby-lsp/pull/123)
-
-## [0.0.3]
-
-- Fixed code actions return hanging
-- Moved to incremental text synchronization
-- Added syntax error resiliency
-
-## [0.0.2]
-
-- Alpha release including
-    - RuboCop formatting, diagnostics and quick fixes
-    - Folding ranges
-    - Initial semantic highlighting
-    - Document symbols