rubocop 1.71.1 → 1.92.1

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 explain lsp mcp
+    ].freeze
     DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
 
     def initialize
@@ -31,6 +33,9 @@ module RuboCop
 
       define_options.parse!(args)
 
+      return_path_given_to_changed(args)
+      imply_autocorrect_for_diff
+
       @validator.validate_compatibility
 
       if @options[:stdin]
@@ -49,7 +54,22 @@ module RuboCop
 
     private
 
-    # rubocop:disable Metrics/AbcSize
+    # `--changed lib` hands the path to `--changed` as its optional argument,
+    # so it goes back among the paths to inspect.
+    def return_path_given_to_changed(args)
+      args.unshift(@path_given_to_changed) if @path_given_to_changed
+    end
+
+    # `--diff` is a dry run of autocorrection, so it turns autocorrection on
+    # unless the user already picked a mode with `-a`, `-A` or `-x`.
+    def imply_autocorrect_for_diff
+      return unless @options[:diff] && !@options[:autocorrect]
+
+      @options[:safe_autocorrect] = true
+      @options[:autocorrect] = true
+    end
+
+    # rubocop:disable-next Metrics/AbcSize
     def define_options
       OptionParser.new do |opts|
         opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
@@ -57,6 +77,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)
@@ -68,7 +89,6 @@ module RuboCop
         add_profile_options(opts) if RUBY_ENGINE == 'ruby' && !Platform.windows?
       end
     end
-    # rubocop:enable Metrics/AbcSize
 
     def add_check_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       section(opts, 'Basic Options') do # rubocop:disable Metrics/BlockLength
@@ -88,12 +108,22 @@ 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, '--[no-]preview')
         option(opts, '--ignore-disable-comments')
         option(opts, '--force-exclusion')
         option(opts, '--only-recognized-file-types')
         option(opts, '--ignore-parent-exclusion')
         option(opts, '--ignore-unrecognized-cops')
         option(opts, '--force-default-config')
+        option(opts, '--changed [REVISION]') do |revision|
+          if @validator.path_given_to_changed?(revision)
+            @path_given_to_changed = revision
+            revision = nil
+          end
+          @options[:changed] = revision || ChangedFiles::DEFAULT_REVISION
+        end
         option(opts, '-s', '--stdin FILE')
         option(opts, '--editor-mode')
         option(opts, '-P', '--[no-]parallel')
@@ -127,10 +157,14 @@ module RuboCop
         option(opts, '--display-only-fail-level-offenses')
         option(opts, '--display-only-correctable')
         option(opts, '--display-only-safe-correctable')
+        option(opts, '--display-suppressed')
+        option(opts, '--max-offenses-per-cop COUNT') do
+          @validator.validate_max_offenses_per_cop_option
+        end
       end
     end
 
-    # rubocop:todo Naming/InclusiveLanguage
+    # rubocop:todo Naming/InclusiveLanguage -- `--auto-correct` is the deprecated flag name
     # the autocorrect command-line arguments map to the autocorrect @options values like so:
     #                            :fix_layout  :autocorrect  :safe_autocorrect  :autocorrect_all
     # -x, --fix-layout           true         true          -                  -
@@ -156,6 +190,8 @@ module RuboCop
         end
 
         option(opts, '--disable-uncorrectable')
+
+        option(opts, '--diff')
       end
     end
     # rubocop:enable Naming/InclusiveLanguage
@@ -168,6 +204,8 @@ module RuboCop
           @options.replace(ConfigRegeneration.new.options.merge(@options))
         end
 
+        option(opts, '--report-unused-todo-entries')
+
         option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
         option(opts, '--no-exclude-limit')
 
@@ -215,6 +253,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,12 +273,16 @@ 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
         option(opts, '--show-docs-url [COP1,COP2,...]') do |list|
           @options[:show_docs_url] = list.nil? ? [] : list.split(',')
         end
+        option(opts, '--explain COP1,COP2,...') do |list|
+          @options[:explain] = list.split(',')
+        end
       end
     end
 
@@ -243,6 +291,7 @@ module RuboCop
         option(opts, '--init')
         option(opts, '-c', '--config FILE')
         option(opts, '-d', '--debug')
+        option(opts, '--plugin FILE') { |f| plugin_feature(f) }
         option(opts, '-r', '--require FILE') { |f| require_feature(f) }
         option(opts, '--[no-]color')
         option(opts, '-v', '--version')
@@ -299,11 +348,25 @@ module RuboCop
       long_opt[2..].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
 
-    def require_feature(file)
-      # If any features were added on the CLI from `--require`,
+    def plugin_feature(file)
+      # If any features were added on the CLI from `--plugin`,
       # add them to the config.
-      ConfigLoader.add_loaded_features(file)
-      require file
+      ConfigLoaderResolver.new.resolve_plugins(Config.new, file)
+    end
+
+    def require_feature(file)
+      if Plugin.plugin_capable?(file)
+        # NOTE: Compatibility for before plugins style.
+        warn Rainbow(<<~MESSAGE).yellow
+          #{file} gem supports plugin, use `--plugin` instead of `--require`.
+        MESSAGE
+        plugin_feature(file)
+      else
+        # If any features were added on the CLI from `--require`,
+        # add them to the config.
+        require file
+        ConfigLoader.add_loaded_features(file)
+      end
     end
   end
 
@@ -355,7 +418,7 @@ module RuboCop
       %i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) }
     end
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable-next Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_redundant_disable?
         raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.'
@@ -371,13 +434,15 @@ module RuboCop
       validate_display_only_failed_and_display_only_correctable
       validate_display_only_correctable_and_autocorrect
       validate_lsp_and_editor_mode
+      validate_diff
+      validate_changed_and_stdin
+      validate_enable_all_cops_and_disable_all_cops
       disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
 
       raise OptionArgumentError, "Incompatible cli options: #{incompatible_options.inspect}"
     end
-    # rubocop:enable Metrics/AbcSize
 
     def validate_auto_gen_config
       return if @options.key?(:auto_gen_config)
@@ -397,7 +462,7 @@ module RuboCop
       return if @options[:format] == 'junit'
 
       raise OptionArgumentError,
-            format('--display-only-failed can only be used together with --format junit.')
+            '--display-only-failed can only be used together with --format junit.'
     end
 
     def validate_display_only_correctable_and_autocorrect
@@ -415,14 +480,34 @@ module RuboCop
                 !@options.key?(:display_only_safe_correctable)
 
       raise OptionArgumentError,
-            format('--display-only-failed cannot be used together with other display options.')
+            '--display-only-failed cannot be used together with other display options.'
+    end
+
+    # `--diff` promises not to write anything, and `--auto-gen-config` exists to
+    # write a file.
+    def validate_diff
+      return unless @options.key?(:diff) && @options.key?(:auto_gen_config)
+
+      raise OptionArgumentError, '--diff cannot be used with --auto-gen-config.'
+    end
+
+    def validate_changed_and_stdin
+      return unless @options.key?(:changed) && @options.key?(:stdin)
+
+      raise OptionArgumentError, '--changed cannot be used with --stdin.'
     end
 
     def validate_lsp_and_editor_mode
       return if !@options.key?(:lsp) || !@options.key?(:editor_mode)
 
+      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,
-            format('Do not specify `--editor-mode` as it is redundant in `--lsp`.')
+            '--enable-all-cops cannot be used together with --disable-all-cops.'
     end
 
     def validate_autocorrect
@@ -436,11 +521,11 @@ module RuboCop
       return unless @options.key?(:disable_uncorrectable)
 
       raise OptionArgumentError,
-            format('--disable-uncorrectable can only be used together with --autocorrect.')
+            '--disable-uncorrectable can only be used together with --autocorrect.'
     end
 
     def disable_parallel_when_invalid_option_combo
-      return unless @options.key?(:parallel)
+      return unless @options[:parallel]
 
       invalid_flags = invalid_arguments_for_parallel
 
@@ -448,13 +533,14 @@ module RuboCop
 
       @options.delete(:parallel)
 
-      puts '-P/--parallel is being ignored because ' \
+      # On stderr, so that it can't end up in the middle of a formatter's
+      # output, such as `--format json`.
+      warn '-P/--parallel is being ignored because ' \
            "it is not compatible with #{invalid_flags.join(', ')}."
     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
@@ -477,6 +563,25 @@ module RuboCop
       @incompatible_options ||= @options.keys & Options::EXITING_OPTIONS
     end
 
+    # OptionParser hands `--changed lib/` the path as the revision, which is a
+    # natural thing to type, so an argument that names an existing path is
+    # taken as one. When it also names a revision there is no telling which
+    # was meant, and git itself refuses such an argument as ambiguous.
+    def path_given_to_changed?(revision)
+      return false unless revision && File.exist?(revision)
+      return true unless ChangedFiles.revision?(revision)
+
+      raise OptionArgumentError,
+            "--changed got `#{revision}`, which is both a path and a git revision. Write " \
+            "`./#{revision}` for the path, or `--changed=#{revision}^0` for the revision."
+    end
+
+    def validate_max_offenses_per_cop_option
+      return if /^[1-9]\d*$/.match?(@options[:max_offenses_per_cop])
+
+      raise OptionParser::InvalidArgument, '--max-offenses-per-cop must be a positive integer'
+    end
+
     def validate_exclude_limit_option
       return if /^\d+$/.match?(@options[:exclude_limit])
 
@@ -494,7 +599,7 @@ module RuboCop
 
   # This module contains help texts for command line options.
   # @api private
-  # rubocop:disable Metrics/ModuleLength
+  # rubocop:disable-next Metrics/ModuleLength
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
@@ -504,6 +609,7 @@ module RuboCop
       only_guide_cops:                  ['Run only cops for rules that link to a',
                                          'style guide.'],
       except:                           'Exclude the given cop(s).',
+      plugin:                           'Load a RuboCop plugin.',
       require:                          'Require Ruby file.',
       config:                           'Specify configuration file.',
       auto_gen_config:                  ['Generate a configuration file acting as a',
@@ -511,6 +617,8 @@ module RuboCop
       regenerate_todo:                  ['Regenerate the TODO configuration file using',
                                          'the last configuration. If there is no existing',
                                          'TODO file, acts like --auto-gen-config.'],
+      report_unused_todo_entries:       ['Also report TODO configuration file entries that',
+                                         'are no longer needed, and fail if any are found.'],
       offense_counts:                   ['Include offense counts in configuration',
                                          'file generated by --auto-gen-config.',
                                          'Default is true.'],
@@ -529,12 +637,21 @@ module RuboCop
                                          'when running --auto-gen-config, except if the',
                                          'number of files with offenses is bigger than',
                                          'exclude-limit. Default is false.'],
+      max_offenses_per_cop:             ['Report at most COUNT offenses per cop across the',
+                                         'whole run, so a single noisy cop cannot bury the',
+                                         'rest. Offenses beyond the limit are not reported',
+                                         'and do not count towards the totals, the same way',
+                                         'the other display filters work.'],
       exclude_limit:                    ['Set the limit for how many files to explicitly exclude.',
                                          'If there are more files than the limit, the cop will',
                                          "be disabled instead. Default is #{MAX_EXCL}."],
       disable_uncorrectable:            ['Used with --autocorrect to annotate any',
                                          'offenses that do not support autocorrect',
                                          'with `rubocop:todo` comments.'],
+      diff:                             ['Print a unified diff of what autocorrection',
+                                         'would change, without writing any files.',
+                                         'Turns on safe autocorrection unless a mode',
+                                         'was already given with -a, -A or -x.'],
       no_exclude_limit:                 ['Do not set the limit for how many files to exclude.'],
       force_exclusion:                  ['Any files excluded by `Exclude` in configuration',
                                          'files will be excluded, even if given explicitly',
@@ -542,11 +659,15 @@ module RuboCop
       only_recognized_file_types:       ['Inspect files given on the command line only if',
                                          'they are listed in `AllCops/Include` parameters',
                                          'of user configuration or default configuration.'],
-      ignore_disable_comments:          ['Run cops even when they are disabled locally',
-                                         'by a `rubocop:disable` directive.'],
+      ignore_disable_comments:          ['Report offenses even if they have been manually disabled',
+                                         'with a `rubocop:disable` or `rubocop:todo` directive.'],
       ignore_parent_exclusion:          ['Prevent from inheriting `AllCops/Exclude` from',
                                          'parent folders.'],
       ignore_unrecognized_cops:         ['Ignore unrecognized cops or departments in the config.'],
+      changed:                          ['Inspect only the files that differ from a git',
+                                         'revision, defaulting to HEAD. Untracked files',
+                                         'count as changed. Pass a revision with',
+                                         '`--changed=REVISION`.'],
       force_default_config:             ['Use default configuration even if configuration',
                                          'files are present in the directory tree.'],
       format:                           ['Choose an output formatter. This option',
@@ -561,6 +682,7 @@ module RuboCop
                                          'specified --format, or the default format',
                                          'if no format is specified.'],
       fail_level:                       ['Minimum severity for exit with error code.',
+                                         'Overrides `AllCops: FailLevel` in the configuration.',
                                          '  [A] autocorrect',
                                          '  [I] info',
                                          '  [R] refactor',
@@ -577,10 +699,16 @@ 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',
+      display_suppressed:               ['Also output offenses suppressed by directive',
+                                         'comments. They do not affect the exit code.'],
+      show_cops:                        ['Show the given cops, or all cops by',
                                          'default, and their configurations for the',
                                          'current directory.',
                                          'You can use `*` as a wildcard.'],
+      explain:                          ['Explain what the given cops do: their',
+                                         'description, configuration, whether they',
+                                         'correct, and the examples from their own',
+                                         'documentation.'],
       show_docs_url:                    ['Display url to documentation for the given',
                                          'cops, or base url by default.'],
       fail_fast:                        ['Inspect files in order of modification',
@@ -597,8 +725,20 @@ 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.',
+      preview:                          ['Opt in to unstable behavior: cops that are',
+                                         '`Enabled: preview`, and changes to existing',
+                                         'cops that are not the default yet.',
+                                         'Overrides `AllCops: Preview`.'],
+      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.',
@@ -606,6 +746,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)',
@@ -636,6 +778,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.'],
@@ -643,5 +787,4 @@ module RuboCop
       memory:                           'Profile rubocop memory usage.'
     }.freeze
   end
-  # rubocop:enable Metrics/ModuleLength
 end

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.
@@ -28,7 +40,11 @@ module RuboCop
         end
     end
 
-    SMART_PATH_CACHE = {} # rubocop:disable Style/MutableConstant
+    def remote_file?(uri)
+      uri.start_with?('http://', 'https://')
+    end
+
+    SMART_PATH_CACHE = {} # rubocop:disable Style/MutableConstant -- a cache, written to at runtime
     private_constant :SMART_PATH_CACHE
 
     def smart_path(path)
@@ -37,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)
@@ -47,7 +63,7 @@ module RuboCop
         end
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # rubocop:disable-next Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def match_path?(pattern, path)
       case pattern
       when String
@@ -73,7 +89,6 @@ module RuboCop
         end
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # Returns true for an absolute Unix or Windows path.
     def absolute?(path)

data/lib/rubocop/pending_cops_reporter.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Reports information about pending cops that are not explicitly configured.
+  #
+  # This class is responsible for displaying warnings when new cops have been added to RuboCop
+  # but have not yet been enabled or disabled in the user's configuration.
+  # It provides a centralized way to determine whether such warnings should be shown,
+  # based on global flags or configuration settings.
+  class PendingCopsReporter
+    class << self
+      PENDING_BANNER = <<~BANNER
+        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
+
+        Please also note that you can opt-in to new cops by default by adding this to your config:
+          AllCops:
+            NewCops: enable
+      BANNER
+
+      attr_accessor :disable_pending_cops, :enable_pending_cops
+
+      def warn_if_needed(config)
+        return if disable_pending_cops || enable_pending_cops
+
+        pending_cops = pending_cops_only_qualified(config.pending_cops)
+        warn_on_pending_cops(pending_cops) unless pending_cops.empty?
+      end
+
+      private
+
+      def pending_cops_only_qualified(pending_cops)
+        pending_cops.select { |cop| Cop::Registry.qualified_cop?(cop.name) }
+      end
+
+      def warn_on_pending_cops(pending_cops)
+        warn Rainbow(PENDING_BANNER).yellow
+
+        pending_cops.each { |cop| warn_pending_cop cop }
+
+        warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
+      end
+
+      def warn_pending_cop(cop)
+        version = cop.metadata['VersionAdded'] || 'N/A'
+
+        warn Rainbow("#{cop.name}: # new in #{version}").yellow
+        warn Rainbow('  Enabled: true').yellow
+      end
+    end
+  end
+end