rubocop 1.79.2 → 1.87.0

data/lib/rubocop.rb

@@ -39,6 +39,7 @@ require_relative 'rubocop/warning'
 
 # rubocop:disable Style/RequireOrder
 
+require_relative 'rubocop/project_index_loader'
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
 require_relative 'rubocop/cop/message_annotator'
@@ -52,6 +53,7 @@ require_relative 'rubocop/cop/cop'
 require_relative 'rubocop/cop/commissioner'
 require_relative 'rubocop/cop/documentation'
 require_relative 'rubocop/cop/corrector'
+require_relative 'rubocop/cop/correctors'
 require_relative 'rubocop/cop/force'
 require_relative 'rubocop/cop/severity'
 require_relative 'rubocop/cop/generator'
@@ -68,109 +70,18 @@ require_relative 'rubocop/cop/variable_force/reference'
 require_relative 'rubocop/cop/variable_force/scope'
 require_relative 'rubocop/cop/variable_force/variable_table'
 
-require_relative 'rubocop/cop/mixin/array_min_size'
-require_relative 'rubocop/cop/mixin/array_syntax'
-require_relative 'rubocop/cop/mixin/alignment'
-require_relative 'rubocop/cop/mixin/allowed_identifiers'
-require_relative 'rubocop/cop/mixin/allowed_methods'
-require_relative 'rubocop/cop/mixin/allowed_pattern'
-require_relative 'rubocop/cop/mixin/allowed_receivers'
-require_relative 'rubocop/cop/mixin/forbidden_identifiers'
-require_relative 'rubocop/cop/mixin/forbidden_pattern'
-require_relative 'rubocop/cop/mixin/auto_corrector' # rubocop:todo Naming/InclusiveLanguage
-require_relative 'rubocop/cop/mixin/check_assignment'
-require_relative 'rubocop/cop/mixin/check_line_breakable'
-require_relative 'rubocop/cop/mixin/check_single_line_suitability'
-require_relative 'rubocop/cop/mixin/configurable_max'
-require_relative 'rubocop/cop/mixin/code_length' # relies on configurable_max
-require_relative 'rubocop/cop/mixin/configurable_enforced_style'
-require_relative 'rubocop/cop/mixin/configurable_formatting'
-require_relative 'rubocop/cop/mixin/configurable_naming'
-require_relative 'rubocop/cop/mixin/configurable_numbering'
-require_relative 'rubocop/cop/mixin/dig_help'
-require_relative 'rubocop/cop/mixin/documentation_comment'
-require_relative 'rubocop/cop/mixin/duplication'
-require_relative 'rubocop/cop/mixin/range_help'
-require_relative 'rubocop/cop/mixin/annotation_comment' # relies on range
-require_relative 'rubocop/cop/mixin/empty_lines_around_body' # relies on range
-require_relative 'rubocop/cop/mixin/empty_parameter'
-require_relative 'rubocop/cop/mixin/end_keyword_alignment'
-require_relative 'rubocop/cop/mixin/endless_method_rewriter'
-require_relative 'rubocop/cop/mixin/enforce_superclass'
-require_relative 'rubocop/cop/mixin/first_element_line_break'
-require_relative 'rubocop/cop/mixin/frozen_string_literal'
-require_relative 'rubocop/cop/mixin/gem_declaration'
-require_relative 'rubocop/cop/mixin/gemspec_help'
-require_relative 'rubocop/cop/mixin/hash_alignment_styles'
-require_relative 'rubocop/cop/mixin/hash_subset'
-require_relative 'rubocop/cop/mixin/hash_transform_method'
-require_relative 'rubocop/cop/mixin/integer_node'
-require_relative 'rubocop/cop/mixin/interpolation'
-require_relative 'rubocop/cop/mixin/line_length_help'
-require_relative 'rubocop/cop/mixin/match_range'
+require_relative 'rubocop/cop/mixin'
+# TODO: move to Layout module once cop lazy loading is implemented
+require_relative 'rubocop/cop/mixin/empty_lines_around_body'
+# TODO: move to Lint module once cop lazy loading is implemented
+require_relative 'rubocop/cop/mixin/unused_argument'
 require_relative 'rubocop/cop/metrics/utils/repeated_csend_discount'
 require_relative 'rubocop/cop/metrics/utils/repeated_attribute_discount'
-require_relative 'rubocop/cop/mixin/hash_shorthand_syntax'
-require_relative 'rubocop/cop/mixin/method_complexity'
-require_relative 'rubocop/cop/mixin/method_preference'
-require_relative 'rubocop/cop/mixin/min_body_length'
-require_relative 'rubocop/cop/mixin/min_branches_count'
-require_relative 'rubocop/cop/mixin/multiline_element_indentation'
-require_relative 'rubocop/cop/mixin/multiline_element_line_breaks'
-require_relative 'rubocop/cop/mixin/multiline_expression_indentation'
-require_relative 'rubocop/cop/mixin/multiline_literal_brace_layout'
-require_relative 'rubocop/cop/mixin/negative_conditional'
-require_relative 'rubocop/cop/mixin/heredoc'
-require_relative 'rubocop/cop/mixin/nil_methods'
-require_relative 'rubocop/cop/mixin/on_normal_if_unless'
-require_relative 'rubocop/cop/mixin/ordered_gem_node'
-require_relative 'rubocop/cop/mixin/parentheses'
-require_relative 'rubocop/cop/mixin/percent_array'
-require_relative 'rubocop/cop/mixin/percent_literal'
-require_relative 'rubocop/cop/mixin/preceding_following_alignment'
-require_relative 'rubocop/cop/mixin/preferred_delimiters'
-require_relative 'rubocop/cop/mixin/rational_literal'
-require_relative 'rubocop/cop/mixin/require_library'
-require_relative 'rubocop/cop/mixin/rescue_node'
-require_relative 'rubocop/cop/mixin/safe_assignment'
-require_relative 'rubocop/cop/mixin/space_after_punctuation'
-require_relative 'rubocop/cop/mixin/space_before_punctuation'
-require_relative 'rubocop/cop/mixin/surrounding_space'
-require_relative 'rubocop/cop/mixin/statement_modifier'
-require_relative 'rubocop/cop/mixin/string_help'
-require_relative 'rubocop/cop/mixin/string_literals_help'
-require_relative 'rubocop/cop/mixin/symbol_help'
-require_relative 'rubocop/cop/mixin/target_ruby_version'
-require_relative 'rubocop/cop/mixin/trailing_body'
-require_relative 'rubocop/cop/mixin/trailing_comma'
-require_relative 'rubocop/cop/mixin/uncommunicative_name'
-require_relative 'rubocop/cop/mixin/unused_argument'
-require_relative 'rubocop/cop/mixin/visibility_help'
-require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
-require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
 
 require_relative 'rubocop/cop/migration/department_name'
 
-require_relative 'rubocop/cop/correctors/alignment_corrector'
-require_relative 'rubocop/cop/correctors/condition_corrector'
-require_relative 'rubocop/cop/correctors/each_to_for_corrector'
-require_relative 'rubocop/cop/correctors/empty_line_corrector'
-require_relative 'rubocop/cop/correctors/for_to_each_corrector'
-require_relative 'rubocop/cop/correctors/if_then_corrector'
-require_relative 'rubocop/cop/correctors/lambda_literal_to_method_corrector'
-require_relative 'rubocop/cop/correctors/line_break_corrector'
-require_relative 'rubocop/cop/correctors/multiline_literal_brace_corrector'
-require_relative 'rubocop/cop/correctors/ordered_gem_corrector'
-require_relative 'rubocop/cop/correctors/parentheses_corrector'
-require_relative 'rubocop/cop/correctors/percent_literal_corrector'
-require_relative 'rubocop/cop/correctors/punctuation_corrector'
-require_relative 'rubocop/cop/correctors/require_library_corrector'
-require_relative 'rubocop/cop/correctors/space_corrector'
-require_relative 'rubocop/cop/correctors/string_literal_corrector'
-require_relative 'rubocop/cop/correctors/unused_arg_corrector'
-
 require_relative 'rubocop/cop/bundler/duplicated_gem'
 require_relative 'rubocop/cop/bundler/duplicated_group'
 require_relative 'rubocop/cop/bundler/gem_comment'
@@ -309,6 +220,7 @@ require_relative 'rubocop/cop/lint/constant_overwritten_in_rescue'
 require_relative 'rubocop/cop/lint/constant_reassignment'
 require_relative 'rubocop/cop/lint/constant_resolution'
 require_relative 'rubocop/cop/lint/cop_directive_syntax'
+require_relative 'rubocop/cop/lint/data_define_override'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
 require_relative 'rubocop/cop/lint/deprecated_constants'
@@ -426,6 +338,7 @@ require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unmodified_reduce_accumulator'
 require_relative 'rubocop/cop/lint/unreachable_code'
 require_relative 'rubocop/cop/lint/unreachable_loop'
+require_relative 'rubocop/cop/lint/unreachable_pattern_branch'
 require_relative 'rubocop/cop/lint/unused_block_argument'
 require_relative 'rubocop/cop/lint/unused_method_argument'
 require_relative 'rubocop/cop/lint/uri_escape_unescape'
@@ -489,6 +402,7 @@ require_relative 'rubocop/cop/style/arguments_forwarding'
 require_relative 'rubocop/cop/style/array_coercion'
 require_relative 'rubocop/cop/style/array_first_last'
 require_relative 'rubocop/cop/style/array_intersect'
+require_relative 'rubocop/cop/style/array_intersect_with_single_element'
 require_relative 'rubocop/cop/style/array_join'
 require_relative 'rubocop/cop/style/ascii_comments'
 require_relative 'rubocop/cop/style/attr'
@@ -540,6 +454,7 @@ require_relative 'rubocop/cop/style/each_for_simple_loop'
 require_relative 'rubocop/cop/style/each_with_object'
 require_relative 'rubocop/cop/style/empty_block_parameter'
 require_relative 'rubocop/cop/style/empty_case_condition'
+require_relative 'rubocop/cop/style/empty_class_definition'
 require_relative 'rubocop/cop/style/empty_else'
 require_relative 'rubocop/cop/style/empty_heredoc'
 require_relative 'rubocop/cop/style/empty_lambda_parameter'
@@ -559,6 +474,7 @@ require_relative 'rubocop/cop/style/exponential_notation'
 require_relative 'rubocop/cop/style/fetch_env_var'
 require_relative 'rubocop/cop/style/file_empty'
 require_relative 'rubocop/cop/style/file_null'
+require_relative 'rubocop/cop/style/file_open'
 require_relative 'rubocop/cop/style/file_read'
 require_relative 'rubocop/cop/style/file_touch'
 require_relative 'rubocop/cop/style/file_write'
@@ -576,6 +492,7 @@ require_relative 'rubocop/cop/style/hash_each_methods'
 require_relative 'rubocop/cop/style/hash_except'
 require_relative 'rubocop/cop/style/hash_fetch_chain'
 require_relative 'rubocop/cop/style/hash_like_case'
+require_relative 'rubocop/cop/style/hash_lookup_method'
 require_relative 'rubocop/cop/style/hash_slice'
 require_relative 'rubocop/cop/style/hash_syntax'
 require_relative 'rubocop/cop/style/hash_transform_keys'
@@ -589,6 +506,7 @@ require_relative 'rubocop/cop/style/if_with_semicolon'
 require_relative 'rubocop/cop/style/implicit_runtime_error'
 require_relative 'rubocop/cop/style/in_pattern_then'
 require_relative 'rubocop/cop/style/infinite_loop'
+require_relative 'rubocop/cop/style/reduce_to_hash'
 require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
 require_relative 'rubocop/cop/style/invertible_unless_condition'
@@ -602,15 +520,19 @@ require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/magic_comment_format'
 require_relative 'rubocop/cop/style/map_into_array'
+require_relative 'rubocop/cop/style/map_join'
 require_relative 'rubocop/cop/style/map_to_hash'
 require_relative 'rubocop/cop/style/map_to_set'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
 require_relative 'rubocop/cop/style/min_max_comparison'
+require_relative 'rubocop/cop/style/module_member_existence_check'
 require_relative 'rubocop/cop/style/multiline_in_pattern_then'
 require_relative 'rubocop/cop/style/numbered_parameters'
+require_relative 'rubocop/cop/style/one_class_per_file'
 require_relative 'rubocop/cop/style/open_struct_use'
 require_relative 'rubocop/cop/style/operator_method_call'
+require_relative 'rubocop/cop/style/partition_instead_of_double_select'
 require_relative 'rubocop/cop/style/redundant_array_constructor'
 require_relative 'rubocop/cop/style/redundant_array_flatten'
 require_relative 'rubocop/cop/style/redundant_assignment'
@@ -626,11 +548,14 @@ require_relative 'rubocop/cop/style/redundant_heredoc_delimiter_quotes'
 require_relative 'rubocop/cop/style/redundant_initialize'
 require_relative 'rubocop/cop/style/redundant_interpolation_unfreeze'
 require_relative 'rubocop/cop/style/redundant_line_continuation'
+require_relative 'rubocop/cop/style/redundant_min_max_by'
 require_relative 'rubocop/cop/style/redundant_regexp_argument'
 require_relative 'rubocop/cop/style/redundant_regexp_constructor'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
+require_relative 'rubocop/cop/style/redundant_struct_keyword_init'
 require_relative 'rubocop/cop/style/require_order'
+require_relative 'rubocop/cop/style/reverse_find'
 require_relative 'rubocop/cop/style/safe_navigation_chain_length'
 require_relative 'rubocop/cop/style/single_line_do_end_block'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
@@ -657,6 +582,7 @@ require_relative 'rubocop/cop/style/negated_if'
 require_relative 'rubocop/cop/style/negated_if_else_condition'
 require_relative 'rubocop/cop/style/negated_unless'
 require_relative 'rubocop/cop/style/negated_while'
+require_relative 'rubocop/cop/style/negative_array_index'
 require_relative 'rubocop/cop/style/nested_file_dirname'
 require_relative 'rubocop/cop/style/nested_modifier'
 require_relative 'rubocop/cop/style/nested_parenthesized_calls'
@@ -681,6 +607,7 @@ require_relative 'rubocop/cop/style/parentheses_around_condition'
 require_relative 'rubocop/cop/style/percent_literal_delimiters'
 require_relative 'rubocop/cop/style/percent_q_literals'
 require_relative 'rubocop/cop/style/perl_backrefs'
+require_relative 'rubocop/cop/style/predicate_with_kind'
 require_relative 'rubocop/cop/style/preferred_hash_methods'
 require_relative 'rubocop/cop/style/proc'
 require_relative 'rubocop/cop/style/quoted_symbols'
@@ -710,6 +637,8 @@ require_relative 'rubocop/cop/style/return_nil'
 require_relative 'rubocop/cop/style/return_nil_in_predicate_method_definition'
 require_relative 'rubocop/cop/style/safe_navigation'
 require_relative 'rubocop/cop/style/sample'
+require_relative 'rubocop/cop/style/select_by_kind'
+require_relative 'rubocop/cop/style/select_by_range'
 require_relative 'rubocop/cop/style/select_by_regexp'
 require_relative 'rubocop/cop/style/self_assignment'
 require_relative 'rubocop/cop/style/semicolon'
@@ -737,6 +666,7 @@ require_relative 'rubocop/cop/style/swap_values'
 require_relative 'rubocop/cop/style/symbol_array'
 require_relative 'rubocop/cop/style/symbol_literal'
 require_relative 'rubocop/cop/style/symbol_proc'
+require_relative 'rubocop/cop/style/tally_method'
 require_relative 'rubocop/cop/style/ternary_parentheses'
 require_relative 'rubocop/cop/style/top_level_method_definition'
 require_relative 'rubocop/cop/style/trailing_body_on_class'
@@ -805,6 +735,8 @@ require_relative 'rubocop/cli/command/auto_generate_config'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/lsp'
+require_relative 'rubocop/cli/command/list_enabled_cops_for'
+require_relative 'rubocop/cli/command/mcp'
 require_relative 'rubocop/cli/command/show_cops'
 require_relative 'rubocop/cli/command/show_docs_url'
 require_relative 'rubocop/cli/command/suggest_extensions'

data/lib/ruby_lsp/rubocop/addon.rb

@@ -8,7 +8,10 @@ module RubyLsp
   module RuboCop
     # A Ruby LSP add-on for RuboCop.
     class Addon < RubyLsp::Addon
-      def initializer
+      RESTART_WATCHERS = %w[.rubocop.yml .rubocop_todo.yml .rubocop].freeze
+
+      def initialize
+        super
         @runtime_adapter = nil
       end
 
@@ -16,12 +19,16 @@ module RubyLsp
         '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]'
         )
 
-        @runtime_adapter = RuntimeAdapter.new
+        @runtime_adapter = RuntimeAdapter.new(message_queue)
         global_state.register_formatter('rubocop', @runtime_adapter)
         register_additional_file_watchers(global_state, message_queue)
 
@@ -49,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,13 +69,21 @@ module RubyLsp
       # rubocop:enable 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
 
-        @runtime_adapter = RuntimeAdapter.new
+      private
 
-        ::RuboCop::LSP::Logger.log(<<~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

@@ -7,30 +7,45 @@ module RubyLsp
     # Provides an adapter to bridge RuboCop's built-in LSP runtime with Ruby LSP's add-on.
     # @api private
     class RuntimeAdapter
-      include RubyLsp::Requests::Support::Formatter
+      def initialize(message_queue)
+        @message_queue = message_queue
+        reload_config
+      end
 
-      def initialize
-        config_store = ::RuboCop::ConfigStore.new
+      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)
-        @runtime.offenses(
-          uri_to_path(uri),
-          document.source,
-          document.encoding,
-          prism_result: prism_result(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)
-        @runtime.format(
-          uri_to_path(uri),
-          document.source,
-          command: 'rubocop.formatAutocorrects',
-          prism_result: prism_result(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)
@@ -43,6 +58,25 @@ module RubyLsp
 
       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)