Class: RuboCop::Cop::Style::TrailingComma

Inherits:
Cop
  • Object
show all
Includes:
ArraySyntax, ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/trailing_comma.rb

Overview

This cop checks for trailing comma in parameter lists and literals.

Examples:

# always bad
a = [1, 2,]
b = [
  1, 2,
  3,
]

# good if EnforcedStyleForMultiline is comma
a = [
  1,
  2,
]

# good if EnforcedStyleForMultiline is no_comma
a = [
  1,
  2
]

Constant Summary collapse

MSG = 
'%s comma after the last %s'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #style, #unrecognized_style_detected

Methods included from ArraySyntax

#array_of?, #square_brackets?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object 



33
34
35
 
# File 'lib/rubocop/cop/style/trailing_comma.rb', line 33

def on_array(node)
  check_literal(node, 'item of %s array') if square_brackets?(node)
end

#on_hash(node) ⇒ Object 



37
38
39
 
# File 'lib/rubocop/cop/style/trailing_comma.rb', line 37

def on_hash(node)
  check_literal(node, 'item of %s hash')
end

#on_send(node) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/trailing_comma.rb', line 41

def on_send(node)
  _receiver, _method_name, *args = *node
  return if args.empty?
  # It's impossible for a method call without parentheses to have
  # a trailing comma.
  return unless brackets?(node)

  check(node, args, 'parameter of %s method call',
        args.last.loc.expression.end_pos, node.loc.expression.end_pos)
end