rubocop 1.79.2 → 1.88.0

data/lib/rubocop/mcp/server.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+begin
+  require 'mcp'
+
+  required_mcp_version = '0.6.0'
+
+  if Gem::Version.new(required_mcp_version) > Gem::Version.new(MCP::VERSION)
+    # While `mcp` is not a runtime dependency, users may have an outdated version installed.
+    warn <<~MESSAGE
+      Error: `mcp` gem version #{MCP::VERSION} was loaded, but `rubocop --mcp` requires #{required_mcp_version}.
+      - If you're using Bundler and don't yet have `gem 'mcp'` as a dependency, add it now.
+      - If you're using Bundler and already have `gem 'mcp'` as a dependency, update it to the most recent version.
+      - If you don't use Bundler, run `gem update mcp`.
+    MESSAGE
+    exit!
+  end
+rescue LoadError => e
+  raise unless e.path == 'mcp'
+
+  warn <<~MESSAGE
+    Error: Unable to load `mcp` gem. Add `gem 'mcp', '~> 0.6'` to your Gemfile, or run `gem install mcp`.
+  MESSAGE
+
+  exit!
+end
+
+require_relative '../lsp'
+require_relative '../lsp/runtime'
+
+module RuboCop
+  module MCP
+    # RuboCop MCP Server.
+    # @api private
+    class Server
+      def initialize(config_store)
+        @config_store = config_store
+        @runtime = RuboCop::LSP::Runtime.new(@config_store)
+        @options = {}
+      end
+
+      def start
+        # No `protocol_version` is specified because draft feature by default can be used.
+        server = ::MCP::Server.new(
+          name: 'rubocop_mcp_server',
+          version: RuboCop::Version::STRING,
+          tools: [inspection_tool, autocorrection_tool]
+        )
+
+        ::MCP::Server::Transports::StdioTransport.new(server).open
+      end
+
+      private
+
+      def inspection_tool
+        build_tool(
+          name: 'rubocop_inspection',
+          description: 'Inspect Ruby code for offenses. ' \
+                       'Provide `source_code` to check inline code or `path` to check files.',
+          title: "RuboCop's inspection",
+          destructive_hint: false,
+          idempotent_hint: true,
+          read_only_hint: true,
+          safety_required: false
+        ) do |path, source_code|
+          run_inspection(path, source_code)
+        end
+      end
+
+      def autocorrection_tool
+        build_tool(
+          name: 'rubocop_autocorrection',
+          description: 'Autocorrect RuboCop offenses in Ruby code. ' \
+                       'Provide `source_code` to correct inline code or `path` to correct files. ' \
+                       'Set `safety` to false to include unsafe corrections.',
+          title: "RuboCop's autocorrection",
+          destructive_hint: true,
+          idempotent_hint: false,
+          read_only_hint: false,
+          safety_required: true
+        ) do |path, source_code, safety|
+          run_autocorrection(path, source_code, safety)
+        end
+      end
+
+      def run_inspection(path, source_code)
+        if source_code
+          offenses = @runtime.offenses(path || 'example.rb', source_code, source_code.encoding)
+          offenses.to_json
+        else
+          process_files(path, filter_empty: true) do |file, source|
+            offenses = @runtime.offenses(file, source, source.encoding)
+
+            { path: PathUtil.relative_path(file), offenses: offenses }
+          end
+        end
+      end
+
+      def run_autocorrection(path, source_code, safety)
+        command = safety ? 'rubocop.formatAutocorrects' : 'rubocop.formatAutocorrectsAll'
+
+        if source_code
+          @runtime.format(path || 'example.rb', source_code, command: command).tap do |corrected|
+            write_file(path, corrected) if path
+          end
+        else
+          process_files(path) do |file, source|
+            @runtime.format(file, source, command: command).then do |corrected|
+              write_file(file, corrected)
+
+              { path: PathUtil.relative_path(file), corrected: source != corrected }
+            end
+          end
+        end
+      end
+
+      def process_files(path, filter_empty: false)
+        target_finder = RuboCop::TargetFinder.new(@config_store, @options)
+        target_files = target_finder.find(path ? [path] : [], :only_recognized_file_types)
+        all_files = target_files.map { |file| yield(file, read_file(file)) }
+        files = filter_empty ? all_files.reject { |f| f[:offenses]&.empty? } : all_files
+
+        { files: files, summary: build_summary(target_files, all_files) }.to_json
+      end
+
+      def read_file(file)
+        config = @config_store.for_file(file)
+        RuboCop::ProcessedSource.from_file(
+          file, config.target_ruby_version, parser_engine: config.parser_engine
+        ).raw_source
+      rescue Errno::ENOENT
+        raise RuboCop::Error, "No such file or directory: #{file}"
+      end
+
+      def write_file(file, content)
+        File.write(file, content)
+      rescue Errno::EACCES
+        raise RuboCop::Error, "Permission denied: #{file}"
+      rescue Errno::ENOSPC
+        raise RuboCop::Error, "No space left on device: #{file}"
+      rescue Errno::EROFS
+        raise RuboCop::Error, "Read-only file system: #{file}"
+      end
+
+      # NOTE: It is useful for RuboCop's result summary to be shown in the LLM's responses
+      # during interactions, so the summary is returned in a form that is easy for the LLM
+      # to reason about. Since LLM execution is non-deterministic, it is also sensible to
+      # compute the summary deterministically at this stage.
+      def build_summary(target_files, files)
+        summary = { target_file_count: target_files.count }
+        if files.first&.key?(:offenses)
+          summary[:offense_count] = files.sum { |f| f[:offenses].size }
+        else
+          summary[:corrected_file_count] = files.count { |f| f[:corrected] }
+        end
+        summary
+      end
+
+      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      def build_tool(
+        name:, description:,
+        title:, destructive_hint:, idempotent_hint:, read_only_hint:, safety_required:
+      )
+        if safety_required
+          safety_property = { safety: { type: 'boolean' } }
+          required = ['safety']
+        else
+          safety_property = {}
+          required = nil
+        end
+
+        ::MCP::Tool.define(
+          name: name,
+          description: description,
+          input_schema: {
+            properties: {
+              path: { type: 'string' },
+              source_code: { type: 'string' }
+            }.merge(safety_property),
+            required: required
+          }.compact,
+          annotations: {
+            title: title,
+            destructive_hint: destructive_hint,
+            idempotent_hint: idempotent_hint,
+            open_world_hint: false,
+            read_only_hint: read_only_hint
+          }
+        ) do |path: nil, source_code: nil, safety: true|
+          result = yield(path, source_code, safety)
+
+          ::MCP::Tool::Response.new([{ type: 'text', text: result }])
+        rescue RuboCop::Error => e
+          ::MCP::Tool::Response.new([{ type: 'text', text: e.message }], error: true)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
+    end
+  end
+end

data/lib/rubocop/options.rb

@@ -16,7 +16,9 @@ module RuboCop
                       'root of the project. RuboCop will use this path to determine which ' \
                       'cops are enabled (via eg. Include/Exclude), and so that certain cops ' \
                       'like Naming/FileName can be checked.'
-    EXITING_OPTIONS = %i[version verbose_version show_cops show_docs_url lsp].freeze
+    EXITING_OPTIONS = %i[
+      version verbose_version show_cops list_enabled_cops_for show_docs_url lsp mcp
+    ].freeze
     DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
 
     def initialize
@@ -57,6 +59,7 @@ module RuboCop
         add_check_options(opts)
         add_cache_options(opts)
         add_lsp_option(opts)
+        add_mcp_option(opts)
         add_server_options(opts)
         add_output_options(opts)
         add_autocorrection_options(opts)
@@ -88,6 +91,8 @@ module RuboCop
         option(opts, '-F', '--fail-fast')
         option(opts, '--disable-pending-cops')
         option(opts, '--enable-pending-cops')
+        option(opts, '--disable-all-cops')
+        option(opts, '--enable-all-cops')
         option(opts, '--ignore-disable-comments')
         option(opts, '--force-exclusion')
         option(opts, '--only-recognized-file-types')
@@ -215,6 +220,12 @@ module RuboCop
       end
     end
 
+    def add_mcp_option(opts)
+      section(opts, 'MCP Option') do
+        option(opts, '--mcp')
+      end
+    end
+
     def add_server_options(opts)
       section(opts, 'Server Options') do
         option(opts, '--[no-]server')
@@ -229,6 +240,7 @@ module RuboCop
     def add_additional_modes(opts)
       section(opts, 'Additional Modes') do
         option(opts, '-L', '--list-target-files')
+        option(opts, '--list-enabled-cops-for PATH')
         option(opts, '--show-cops [COP1,COP2,...]') do |list|
           @options[:show_cops] = list.nil? ? [] : list.split(',')
         end
@@ -386,6 +398,7 @@ module RuboCop
       validate_display_only_failed_and_display_only_correctable
       validate_display_only_correctable_and_autocorrect
       validate_lsp_and_editor_mode
+      validate_enable_all_cops_and_disable_all_cops
       disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
@@ -439,6 +452,13 @@ module RuboCop
       raise OptionArgumentError, 'Do not specify `--editor-mode` as it is redundant in `--lsp`.'
     end
 
+    def validate_enable_all_cops_and_disable_all_cops
+      return if !@options.key?(:enable_all_cops) || !@options.key?(:disable_all_cops)
+
+      raise OptionArgumentError,
+            '--enable-all-cops cannot be used together with --disable-all-cops.'
+    end
+
     def validate_autocorrect
       if @options.key?(:safe_autocorrect) && @options.key?(:autocorrect_all)
         message = Rainbow(<<~MESSAGE).red
@@ -467,8 +487,7 @@ module RuboCop
     end
 
     def invalid_arguments_for_parallel
-      [('--auto-gen-config' if @options.key?(:auto_gen_config)),
-       ('-F/--fail-fast'    if @options.key?(:fail_fast)),
+      [('-F/--fail-fast'    if @options.key?(:fail_fast)),
        ('--profile'         if @options[:profile]),
        ('--memory'          if @options[:memory]),
        ('--cache false'     if @options > { cache: 'false' })].compact
@@ -592,7 +611,7 @@ module RuboCop
       display_only_correctable:         ['Only output correctable offense messages.'],
       display_only_safe_correctable:    ['Only output safe-correctable offense messages',
                                          'when combined with --display-only-correctable.'],
-      show_cops:                        ['Shows the given cops, or all cops by',
+      show_cops:                        ['Show the given cops, or all cops by',
                                          'default, and their configurations for the',
                                          'current directory.',
                                          'You can use `*` as a wildcard.'],
@@ -612,8 +631,16 @@ module RuboCop
       display_cop_names:                ['Display cop names in offense messages.',
                                          'Default is true.'],
       disable_pending_cops:             'Run without pending cops.',
+      disable_all_cops:                 ['Run with all cops disabled by default,',
+                                         'except `Lint/Syntax`. Overrides',
+                                         '`AllCops/EnabledByDefault` and',
+                                         '`AllCops/DisabledByDefault` in config files.'],
       display_style_guide:              'Display style guide URLs in offense messages.',
       enable_pending_cops:              'Run with pending cops.',
+      enable_all_cops:                  ['Run with all cops enabled, including those',
+                                         'disabled by default. Overrides',
+                                         '`AllCops/EnabledByDefault` and',
+                                         '`AllCops/DisabledByDefault` in config files.'],
       extra_details:                    'Display extra details in offense messages.',
       lint:                             'Run only lint cops.',
       safe:                             'Run only safe cops.',
@@ -621,6 +648,8 @@ module RuboCop
                                          'autocorrected source. This is especially useful',
                                          'when combined with --autocorrect and --stdin.'],
       list_target_files:                'List all files RuboCop will inspect.',
+      list_enabled_cops_for:            ['List which cops will inspect a given file or',
+                                         'directory.'],
       autocorrect:                      'Autocorrect offenses (only when it\'s safe).',
       auto_correct:                     '(same, deprecated)',
       safe_auto_correct:                '(same, deprecated)',
@@ -651,6 +680,8 @@ module RuboCop
       server_status:                    'Show server status.',
       no_detach:                        'Run the server process in the foreground.',
       lsp:                              'Start a language server listening on STDIN.',
+      mcp:                              ['Start an MCP (Model Context Protocol) server that',
+                                         'communicates over stdio.'],
       raise_cop_error:                  ['Raise cop-related errors with cause and location.',
                                          'This is used to prevent cops from failing silently.',
                                          'Default is false.'],

data/lib/rubocop/path_util.rb

@@ -10,7 +10,19 @@ module RuboCop
 
     module_function
 
-    def relative_path(path, base_dir = Dir.pwd)
+    # Returns the current working directory, cached for the duration of a run.
+    # Dir.pwd is a syscall; caching it avoids repeated overhead since RuboCop
+    # never changes the working directory during a run.
+    def pwd
+      @pwd ||= Dir.pwd
+    end
+
+    # Reset the cached pwd. Only needed in tests that use Dir.chdir.
+    def reset_pwd
+      @pwd = nil
+    end
+
+    def relative_path(path, base_dir = PathUtil.pwd)
       PathUtil.relative_paths_cache[base_dir][path] ||=
         # Optimization for the common case where path begins with the base
         # dir. Just cut off the first part.
@@ -41,7 +53,7 @@ module RuboCop
           path.uri.to_s
         else
           # Ideally, we calculate this relative to the project root.
-          base_dir = Dir.pwd
+          base_dir = PathUtil.pwd
 
           if path.start_with? base_dir
             relative_path(path, base_dir)

data/lib/rubocop/plugin/loader.rb

@@ -84,7 +84,7 @@ module RuboCop
         end
 
         def require_plugin(require_path)
-          FeatureLoader.load(config_directory_path: Dir.pwd, feature: require_path)
+          FeatureLoader.load(config_directory_path: PathUtil.pwd, feature: require_path)
         end
 
         def constantize_plugin_from_gemspec_metadata(plugin_name)

data/lib/rubocop/project_index_loader.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Defensive loader for the optional `rubydex` gem.
+  #
+  # When `AllCops/UseProjectIndex` is enabled in the user's configuration, RuboCop builds
+  # a project-wide index using `Rubydex::Graph` and exposes it to cops that opt in.
+  # The gem is intentionally not a runtime dependency; if it is not installed,
+  # or if the running Ruby is older than what `rubydex` supports, RuboCop falls back to
+  # its standard file-local behavior.
+  module ProjectIndexLoader
+    MINIMUM_RUBY_VERSION = '3.2'
+
+    module_function
+
+    # Returns whether the `rubydex` gem can be loaded. The result is memoized
+    # for the lifetime of the process.
+    def available?
+      return @available if defined?(@available)
+
+      @available = supported_ruby? && try_require
+    end
+
+    def supported_ruby?
+      RUBY_VERSION >= MINIMUM_RUBY_VERSION
+    end
+
+    def warn_unavailable
+      return if @warned
+
+      @warned = true
+
+      if supported_ruby?
+        warn Rainbow(<<~MSG).yellow
+          `AllCops/UseProjectIndex` is enabled but the `rubydex` gem is not installed.
+          Analyses that use the project index will be skipped. Add `gem 'rubydex'` to your Gemfile.
+        MSG
+      else
+        warn Rainbow(<<~MSG).yellow
+          `AllCops/UseProjectIndex` is enabled but `rubydex` requires Ruby #{MINIMUM_RUBY_VERSION} or later (current: #{RUBY_VERSION}).
+          Analyses that use the project index will be skipped.
+        MSG
+      end
+    end
+
+    def try_require
+      require 'rubydex'
+      true
+    rescue LoadError
+      false
+    end
+
+    # Builds and resolves a `Rubydex::Graph` for the given file paths. Returns the resolved graph,
+    # or `nil` if the build fails. This is the only place in RuboCop that depends on the concrete
+    # `Rubydex::Graph` API, so callers (e.g. `Runner`) do not need to know which Rubydex classes
+    # or methods are involved.
+    def build_index(paths)
+      graph = Rubydex::Graph.new
+      graph.index_all(paths.map(&:to_s))
+      graph.resolve
+      graph
+    rescue StandardError => e
+      warn Rainbow("rubydex index build failed: #{e.message}. Continuing without it.").yellow
+    end
+  end
+end

data/lib/rubocop/rake_task.rb

@@ -75,7 +75,7 @@ module RuboCop
     def setup_subtasks(name, *args, &task_block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       namespace(name) do
         # rubocop:todo Naming/InclusiveLanguage
-        task(:auto_correct, *args) do
+        task(:auto_correct, *args) do |_, task_args|
           require 'rainbow'
           warn Rainbow(
             'rubocop:auto_correct task is deprecated; ' \

data/lib/rubocop/remote_config.rb

@@ -11,13 +11,13 @@ module RuboCop
 
     CACHE_LIFETIME = 24 * 60 * 60
 
-    def initialize(url, base_dir)
+    def initialize(url, cache_root)
       begin
         @uri = URI.parse(url)
       rescue URI::InvalidURIError
         raise ConfigNotFoundError, "Failed to resolve configuration: '#{url}' is not a valid URI"
       end
-      @base_dir = base_dir
+      @cache_root = cache_root
     end
 
     def file
@@ -27,16 +27,17 @@ module RuboCop
         next if response.is_a?(Net::HTTPNotModified)
         next if response.is_a?(SocketError)
 
+        FileUtils.mkdir_p(File.dirname(cache_path))
         File.write(cache_path, response.body)
       end
 
       cache_path
     end
 
-    def inherit_from_remote(file, path)
+    def inherit_from_remote(file)
       new_uri = @uri.dup
       new_uri.path.gsub!(%r{/[^/]*$}, "/#{file.delete_prefix('./')}")
-      RemoteConfig.new(new_uri.to_s, File.dirname(path))
+      RemoteConfig.new(new_uri.to_s, @cache_root)
     end
 
     private
@@ -80,7 +81,7 @@ module RuboCop
     end
 
     def cache_path
-      File.expand_path(".rubocop-#{cache_name_from_uri}", @base_dir)
+      @cache_path ||= File.expand_path(cache_name_from_uri, @cache_root)
     end
 
     def cache_path_exists?
@@ -97,9 +98,10 @@ module RuboCop
     end
 
     def cache_name_from_uri
-      uri = cloned_url
-      uri.query = nil
-      uri.to_s.gsub!(/[^0-9A-Za-z]/, '-')
+      # The md5 checksum suffix is 37 bytes, so we play it save and
+      # allow 254 bytes total - this should be safe on Linux/macOS/Windows
+      filename = File.basename(@uri.path).gsub(/\.ya?ml\z/i, '').byteslice(0, 217).scrub('')
+      "#{filename}-#{Digest::MD5.hexdigest(@uri.to_s)}.yml"
     end
 
     def cloned_url