Class: RuboCop::Cop::Lint::Debugger

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/debugger.rb

Overview

This cop checks for calls to debugger or pry.

Constant Summary collapse

MSG =
'Remove debugger entry point `%s`.'
DEBUGGER_NODE =

debugger call node

(send nil :debugger)

s(:send, nil, :debugger)
BYEBUG_NODE =

byebug call node

(send nil :byebug)

s(:send, nil, :byebug)
PRY_NODE =

binding.pry node

(send (send nil :binding) :pry)

s(:send, s(:send, nil, :binding), :pry)
REMOTE_PRY_NODE =

binding.remote_pry node

(send (send nil :binding) :remote_pry)

s(:send, s(:send, nil, :binding), :remote_pry)
PRY_REMOTE_NODE =

binding.pry_remote node

(send (send nil :binding) :pry_remote)

s(:send, s(:send, nil, :binding), :pry_remote)
DEBUGGER_NODES =
[
  DEBUGGER_NODE,
  BYEBUG_NODE,
  PRY_NODE,
  REMOTE_PRY_NODE,
  PRY_REMOTE_NODE
]

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 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_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_send(node) ⇒ Object


46
47
48
49
50
51
# File 'lib/rubocop/cop/lint/debugger.rb', line 46

def on_send(node)
  return unless DEBUGGER_NODES.include?(node)
  add_offense(node,
              :expression,
              format(MSG, node.loc.expression.source))
end