Class: RuboCop::Cop::Layout::FirstArrayElementLineBreak

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
FirstElementLineBreak
Defined in:
lib/rubocop/cop/layout/first_array_element_line_break.rb

Overview

Checks for a line break before the first element in a multi-line array.

Examples:


# bad
[ :a,
  :b]

# good
[
  :a,
  :b]

# good
[:a, :b]

AllowMultilineFinalElement: false (default)


# bad
[ :a, {
  :b => :c
}]

# good
[
  :a, {
  :b => :c
}]

AllowMultilineFinalElement: true


# good
[:a, {
  :b => :c
}]

Constant Summary collapse

MSG = 
'Add a line break before the first element of a multi-line array.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object 



49
50
51
52
53
 
# File 'lib/rubocop/cop/layout/first_array_element_line_break.rb', line 49

def on_array(node)
  return if !node.loc.begin && !assignment_on_same_line?(node)

  check_children_line_break(node, node.children, ignore_last: ignore_last_element?)
end