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

Inherits:
Cop
  • Object
show all
Includes:
TrailingComma
Defined in:
lib/rubocop/cop/style/trailing_comma_in_arguments.rb

Overview

This cop checks for trailing comma in argument lists.

Examples:

EnforcedStyleForMultiline: consistent_comma

# bad
method(1, 2,)

# good
method(1, 2)

# good
method(
  1, 2,
  3,
)

# good
method(
  1,
  2,
)

EnforcedStyleForMultiline: comma

# bad
method(1, 2,)

# good
method(1, 2)

# 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

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 


68
69
70
 
# File 'lib/rubocop/cop/style/trailing_comma_in_arguments.rb', line 68

def self.autocorrect_incompatible_with
  [Layout::HeredocArgumentClosingParenthesis]
end

Instance Method Details

#autocorrect(range) ⇒ Object 


64
65
66
 
# File 'lib/rubocop/cop/style/trailing_comma_in_arguments.rb', line 64

def autocorrect(range)
  PunctuationCorrector.swap_comma(range)
end

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


55
56
57
58
59
60
61
 
# File 'lib/rubocop/cop/style/trailing_comma_in_arguments.rb', line 55

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