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

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment
Defined in:
lib/rubocop/cop/style/comment_indentation.rb

Overview

This cops checks the indentation of comments.

Constant Summary collapse

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

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

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 collapse

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #indentation, #offset, #start_of_line?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #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, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, 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 



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

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