Class: RuboCop::Cop::Lint::BlockAlignment
- Includes:
- ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/lint/block_alignment.rb
Overview
This cop checks whether the end keywords are aligned properly for do end blocks.
Three modes are supported through the ‘EnforcedStyleAlignWith` configuration parameter:
‘start_of_block` : the `end` shall be aligned with the start of the line where the `do` appeared.
‘start_of_line` : the `end` shall be aligned with the start of the line where the expression started.
‘either` (which is the default) : the `end` is allowed to be in either location. The autofixer will default to `start_of_line`.
Constant Summary collapse
- MSG =
'%s is not aligned with %s%s.'.freeze
Constants included from Util
Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods included from ConfigurableEnforcedStyle
#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
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, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#on_block(node) ⇒ Object
75 76 77 |
# File 'lib/rubocop/cop/lint/block_alignment.rb', line 75 def on_block(node) check_block_alignment(start_for_block_node(node), node) end |
#style_parameter_name ⇒ Object
79 80 81 |
# File 'lib/rubocop/cop/lint/block_alignment.rb', line 79 def style_parameter_name 'EnforcedStyleAlignWith' end |