Class: RuboCop::Cop::Style::TrailingCommaInArguments

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
TrailingComma
Defined in:
lib/rubocop/cop/style/trailing_comma_in_arguments.rb

Overview

Checks for trailing comma in argument lists. The supported styles are:

  • ‘consistent_comma`: Requires a comma after the last argument,

for all parenthesized multi-line method calls with arguments.

  • ‘comma`: Requires a comma after the last argument, but only for

parenthesized method calls where each argument is on its own line.

  • ‘no_comma`: Requires that there is no comma after the last

argument.

Regardless of style, trailing commas are not allowed in single-line method calls.

Examples:

EnforcedStyleForMultiline: consistent_comma

# bad
method(1, 2,)

# good
method(1, 2)

# good
method(
  1, 2,
  3,
)

# good
method(
  1, 2, 3,
)

# good
method(
  1,
  2,
)

EnforcedStyleForMultiline: comma

# bad
method(1, 2,)

# good
method(1, 2)

# bad
method(
  1, 2,
  3,
)

# good
method(
  1, 2,
  3
)

# bad
method(
  1, 2, 3,
)

# good
method(
  1, 2, 3
)

# good
method(
  1,
  2,
)

EnforcedStyleForMultiline: no_comma (default)

# bad
method(1, 2,)

# good
method(1, 2)

# good
method(
  1,
  2
)

Constant Summary

Constants included from TrailingComma

TrailingComma::MSG

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



94
95
96
 
# File 'lib/rubocop/cop/style/trailing_comma_in_arguments.rb', line 94

def self.autocorrect_incompatible_with
  [Layout::HeredocArgumentClosingParenthesis]
end

Instance Method Details

#on_send(node) ⇒ Object Also known as: on_csend 



98
99
100
101
102
103
104
 
# File 'lib/rubocop/cop/style/trailing_comma_in_arguments.rb', line 98

def on_send(node)
  return unless node.arguments? && node.parenthesized?

  check(node, node.arguments, 'parameter of %<article>s method call',
        node.last_argument.source_range.end_pos,
        node.source_range.end_pos)
end