Class: RuboCop::Cop::Style::CommentIndentation

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::CommentIndentation

Includes:

AutocorrectAlignment

Defined in:

lib/rubocop/cop/style/comment_indentation.rb

Overview

This cops checks the indentation of comments.

Constant Summary

MSG =

'Incorrect indentation detected (column %d instead of %d).'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #investigate(processed_source) ⇒ Object

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #start_of_line?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object

# File 'lib/rubocop/cop/style/comment_indentation.rb', line 12

def investigate(processed_source)
  processed_source.comments.each { |comment| check(comment) }
end