Class: RuboCop::Cop::Layout::FirstHashElementLineBreak

Inherits:
Cop
  • Object
show all
Includes:
FirstElementLineBreak
Defined in:
lib/rubocop/cop/layout/first_hash_element_line_break.rb

Overview

This cop checks for a line break before the first element in a multi-line hash.

Examples:


# bad
{ a: 1,
  b: 2}

# good
{
  a: 1,
  b: 2 }

Constant Summary collapse

MSG =
'Add a line break before the first element of a ' \
'multi-line hash.'.freeze

Constants included from Util

Util::ASGN_NODES, 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 inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #target_ruby_version

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 AST::Sexp

#s

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



31
32
33
# File 'lib/rubocop/cop/layout/first_hash_element_line_break.rb', line 31

def autocorrect(node)
  EmptyLineCorrector.insert_before(node)
end

#on_hash(node) ⇒ Object



25
26
27
28
29
# File 'lib/rubocop/cop/layout/first_hash_element_line_break.rb', line 25

def on_hash(node)
  # node.loc.begin tells us whether the hash opens with a {
  # If it doesn't, Style/FirstMethodArgumentLineBreak will handle it
  check_children_line_break(node, node.children) if node.loc.begin
end