Class: RuboCop::Cop::Style::FirstHashElementLineBreak

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::FirstHashElementLineBreak

Includes:

FirstElementLineBreak

Defined in:

lib/rubocop/cop/style/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

MSG =

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_hash(node) ⇒ Object

Methods included from FirstElementLineBreak

#autocorrect

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?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_hash(node) ⇒ Object

# File 'lib/rubocop/cop/style/first_hash_element_line_break.rb', line 26

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