Class: RuboCop::Cop::Layout::MultilineMethodParameterLineBreaks

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

Overview

Ensures that each parameter in a multi-line method definition starts on a separate line.

NOTE: This cop does not move the first argument, if you want that to be on a separate line, see `Layout/FirstMethodParameterLineBreak`.

Examples:

AllowMultilineFinalElement: false (default)


# bad
def foo(a, b,
  c
)
end

# bad
def foo(a, b = {
  foo: "bar",
})
end

# good
def foo(
  a,
  b,
  c
)
end

# good
def foo(
  a,
  b = {
    foo: "bar",
  }
)
end

# good
def foo(a, b, c)
end

AllowMultilineFinalElement: true


# bad
def foo(a, b,
  c
)
end

# good
def foo(a, b = {
  foo: "bar",
})
end

# good
def foo(
  a,
  b,
  c
)
end

# good
def foo(
  a,
  b = {
    foo: "bar",
  }
)
end

# good
def foo(a, b, c)
end

Constant Summary collapse

MSG =
'Each parameter in a multi-line method definition must start on a separate line.'

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, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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_def(node) ⇒ Object


87
88
89
90
91
# File 'lib/rubocop/cop/layout/multiline_method_parameter_line_breaks.rb', line 87

def on_def(node)
  return if node.arguments.empty?

  check_line_breaks(node, node.arguments, ignore_last: ignore_last_element?)
end