Sha256: c08f5ac6b20b311247f03462ee9fbf9aa0854c2f0052f6e2d5310927f6cb09c5

Contents?: true

Size: 1.11 KB

Versions: 6884

Compression:

Stored size: 1.11 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # Common functionality for cops which processes Parser's diagnostics.
    # This mixin requires its user class to define `#relevant_diagnostic?`.
    #
    #     def relevant_diagnostic?(diagnostic)
    #       diagnostic.reason == :my_interested_diagnostic_type
    #     end
    #
    # If you want to use an alternative offense message rather than the one in
    # Parser's diagnostic, define `#alternative_message`.
    #
    #     def alternative_message(diagnostic)
    #       'My custom message'
    #     end
    module ParserDiagnostic
      def investigate(processed_source)
        processed_source.diagnostics.each do |d|
          next unless relevant_diagnostic?(d)

          message = if respond_to?(:alternative_message, true)
                      alternative_message(d)
                    else
                      d.message.capitalize
                    end

          add_offense(nil,
                      location: d.location,
                      message: message,
                      severity: d.level)
        end
      end
    end
  end
end

Version data entries

6,884 entries across 6,859 versions & 28 rubygems

Version Path
rubocop-0.61.1 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.61.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/mixin/parser_diagnostic.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/mixin/parser_diagnostic.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/mixin/parser_diagnostic.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.60.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.59.2 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.59.1 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.59.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.58.2 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.58.1 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.58.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.4.0/gems/rubocop-0.57.2/lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.57.2 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.57.1 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.57.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.56.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.55.0 lib/rubocop/cop/mixin/parser_diagnostic.rb
rubocop-0.54.0 lib/rubocop/cop/mixin/parser_diagnostic.rb