rubocop 1.71.1 → 1.92.0

data/lib/ruby_lsp/rubocop/addon.rb

@@ -2,30 +2,34 @@
 
 require_relative '../../rubocop'
 require_relative '../../rubocop/lsp/logger'
-require_relative 'wraps_built_in_lsp_runtime'
+require_relative 'runtime_adapter'
 
 module RubyLsp
   module RuboCop
     # A Ruby LSP add-on for RuboCop.
     class Addon < RubyLsp::Addon
-      def initializer
-        @wraps_built_in_lsp_runtime = nil
+      RESTART_WATCHERS = %w[.rubocop.yml .rubocop_todo.yml .rubocop].freeze
+
+      def initialize
+        super
+        @runtime_adapter = nil
       end
 
       def name
         'RuboCop'
       end
 
+      def version
+        ::RuboCop::Version::STRING
+      end
+
       def activate(global_state, message_queue)
         ::RuboCop::LSP::Logger.log(
           "Activating RuboCop LSP addon #{::RuboCop::Version::STRING}.", prefix: '[RuboCop]'
         )
 
-        ::RuboCop::LSP.enable
-        @wraps_built_in_lsp_runtime = WrapsBuiltinLspRuntime.new
-
-        global_state.register_formatter('rubocop', @wraps_built_in_lsp_runtime)
-
+        @runtime_adapter = RuntimeAdapter.new(message_queue)
+        global_state.register_formatter('rubocop', @runtime_adapter)
         register_additional_file_watchers(global_state, message_queue)
 
         ::RuboCop::LSP::Logger.log(
@@ -34,10 +38,10 @@ module RubyLsp
       end
 
       def deactivate
-        @wraps_built_in_lsp_runtime = nil
+        @runtime_adapter = nil
       end
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable-next Metrics/MethodLength
       def register_additional_file_watchers(global_state, message_queue)
         return unless global_state.supports_watching_files
 
@@ -52,7 +56,7 @@ module RubyLsp
                 register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
                   watchers: [
                     Interface::FileSystemWatcher.new(
-                      glob_pattern: '**/.rubocop{,_todo}.yml',
+                      glob_pattern: "**/{#{RESTART_WATCHERS.join(',')}}",
                       kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE
                     )
                   ]
@@ -62,16 +66,23 @@ module RubyLsp
           )
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
 
       def workspace_did_change_watched_files(changes)
-        return unless changes.any? { |change| change[:uri].end_with?('.rubocop.yml') }
+        if (changed_config_file = changed_config_file(changes))
+          @runtime_adapter.reload_config
+
+          ::RuboCop::LSP::Logger.log(<<~MESSAGE, prefix: '[RuboCop]')
+            Re-initialized RuboCop LSP addon #{::RuboCop::Version::STRING} due to #{changed_config_file} change.
+          MESSAGE
+        end
+      end
 
-        @wraps_built_in_lsp_runtime.init!
+      private
 
-        ::RuboCop::LSP::Logger(<<~MESSAGE, prefix: '[RuboCop]')
-          Re-initialized RuboCop LSP addon #{::RuboCop::Version::STRING} due to .rubocop.yml file change.
-        MESSAGE
+      def changed_config_file(changes)
+        RESTART_WATCHERS.find do |file_name|
+          changes.any? { |change| change[:uri].end_with?(file_name) }
+        end
       end
     end
   end

data/lib/ruby_lsp/rubocop/runtime_adapter.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative '../../rubocop/lsp/runtime'
+
+module RubyLsp
+  module RuboCop
+    # Provides an adapter to bridge RuboCop's built-in LSP runtime with Ruby LSP's add-on.
+    # @api private
+    class RuntimeAdapter
+      def initialize(message_queue)
+        @message_queue = message_queue
+        reload_config
+      end
+
+      def reload_config
+        @runtime = nil
+        options, _paths = ::RuboCop::Options.new.parse([])
+
+        config_store = ::RuboCop::ConfigStore.new
+        config_store.apply_options!(options)
+        @runtime = ::RuboCop::LSP::Runtime.new(config_store)
+      rescue ::RuboCop::Error => e
+        @message_queue << Notification.window_show_message(
+          "RuboCop configuration error: #{e.message}. Formatting will not be available.",
+          type: Constant::MessageType::ERROR
+        )
+      end
+
+      def run_diagnostic(uri, document)
+        with_error_handling do
+          @runtime.offenses(
+            uri_to_path(uri),
+            document.source,
+            document.encoding,
+            prism_result: prism_result(document)
+          )
+        end
+      end
+
+      def run_formatting(uri, document)
+        with_error_handling do
+          @runtime.format(
+            uri_to_path(uri),
+            document.source,
+            command: 'rubocop.formatAutocorrects',
+            prism_result: prism_result(document)
+          )
+        end
+      end
+
+      def run_range_formatting(_uri, _partial_source, _base_indentation)
+        # Not yet supported. Should return the formatted version of `partial_source` which is
+        # a partial selection of the entire document. For example, it should not try to add
+        # a frozen_string_literal magic comment and all style corrections should start from
+        # the `base_indentation`.
+        nil
+      end
+
+      private
+
+      def with_error_handling
+        return unless @runtime
+
+        yield
+      rescue StandardError => e
+        ::RuboCop::LSP::Logger.log(e.full_message, prefix: '[RuboCop]')
+
+        message = if e.is_a?(::RuboCop::ErrorWithAnalyzedFileLocation)
+                    "for the #{e.cop.name} cop"
+                  else
+                    "- #{e.message}"
+                  end
+        raise Requests::Formatting::Error, <<~MSG
+          An internal error occurred #{message}.
+          Updating to a newer version of RuboCop may solve this.
+          For more details, run RuboCop on the command line.
+        MSG
+      end
+
+      # duplicated from: lib/standard/lsp/routes.rb
+      # modified to incorporate Ruby LSP's to_standardized_path method
+      def uri_to_path(uri)
+        if uri.respond_to?(:to_standardized_path) && (standardized_path = uri.to_standardized_path)
+          standardized_path
+        else
+          uri.to_s.delete_prefix('file://')
+        end
+      end
+
+      def prism_result(document)
+        prism_result = document.parse_result
+
+        # NOTE: `prism_result` must be `Prism::ParseLexResult` compatible object.
+        # This is for compatibility parsed result unsupported.
+        prism_result.is_a?(Prism::ParseLexResult) ? prism_result : nil
+      end
+    end
+  end
+end