Class: RuboCop::Cop::Style::InlineComment

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/inline_comment.rb

Overview

This cop checks for trailing inline comments.

Examples:


# good
foo.each do |f|
  # Standalone comment
  f.bar
end

# bad
foo.each do |f|
  f.bar # Trailing inline comment
end

Constant Summary collapse

MSG =
'Avoid trailing inline comments.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_new_investigationObject


23
24
25
26
27
28
29
30
# File 'lib/rubocop/cop/style/inline_comment.rb', line 23

def on_new_investigation
  processed_source.comments.each do |comment|
    next if comment_line?(processed_source[comment.loc.line - 1]) ||
            comment.text.match?(/\A# rubocop:(enable|disable)/)

    add_offense(comment)
  end
end