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

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

Overview

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:

DebuggerMethods:
  WebConsole: ~

You can also add your own methods by adding a new category:

source,yaml

Lint/Debugger:

DebuggerMethods:
  MyDebugger:
    MyDebugger.debug_this

Some gems also ship files that will start a debugging session when required, for example ‘require ’debug/start’‘ from `ruby/debug`. These requires can be configured through `DebuggerRequires`. It has the same structure as `DebuggerMethods`, which you can read about above.

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

DebuggerRequires: [my_debugger/start]


# bad (ok during development)

require 'my_debugger/start'

Constant Summary collapse

MSG = 
'Remove debugger entry point `%<source>s`.'
BLOCK_TYPES = 
%i[block numblock kwbegin].freeze

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

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, 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?, #autocorrect_with_disable_uncorrectable?, #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

#on_send(node) ⇒ Object 



82
83
84
85
86
 
# File 'lib/rubocop/cop/lint/debugger.rb', line 82

def on_send(node)
  return if assumed_usage_context?(node)

  add_offense(node) if debugger_method?(node) || debugger_require?(node)
end