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

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

Overview

This cop checks for debug calls (such as `debugger` or `binding.pry`) that should not be kept for production code.

The cop can be configured using `DebuggerMethods`. By default, a number of gems debug entrypoints are configured (`Kernel`, `Byebug`, `Capybara`, `debug.rb`, `Pry`, `Rails`, `RubyJard`, and `WebConsole`). Additional methods can be added.

Specific default groups can be disabled if necessary:

source,yaml

Lint/Debugger:

WebConsole: ~

Examples:


# bad (ok during development)

# using pry
def some_method
  binding.pry
  do_something
end

# bad (ok during development)

# using byebug
def some_method
  byebug
  do_something
end

# good

def some_method
  do_something
end

DebuggerMethods: [my_debugger]


# bad (ok during development)

def some_method
  my_debugger
end

Constant Summary collapse

MSG =
'Remove debugger entry point `%<source>s`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#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?, #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?, #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

#kernel?(node) ⇒ Object


61
62
63
# File 'lib/rubocop/cop/lint/debugger.rb', line 61

def_node_matcher :kernel?, <<~PATTERN
  (const {nil? cbase} :Kernel)
PATTERN

#on_send(node) ⇒ Object


73
74
75
76
77
# File 'lib/rubocop/cop/lint/debugger.rb', line 73

def on_send(node)
  return unless debugger_method?(node)

  add_offense(node)
end

#valid_receiver?(node, arg1) ⇒ Object


66
67
68
69
70
71
# File 'lib/rubocop/cop/lint/debugger.rb', line 66

def_node_matcher :valid_receiver?, <<~PATTERN
  {
    (const {nil? cbase} %1)
    (send {nil? #kernel?} %1)
  }
PATTERN