Class: RuboCop::Cop::Lint::MissingCopEnableDirective

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

Overview

Checks that there is an ‘# rubocop:enable …` statement after a `# rubocop:disable …` statement. This will prevent leaving cop disables on wide ranges of code, that latter contributors to a file wouldn’t be aware of.

Examples:

# Lint/MissingCopEnableDirective: # MaximumRangeSize: .inf  # good # rubocop:disable Layout/SpaceAroundOperators x= 0 # rubocop:enable Layout/SpaceAroundOperators # y = 1 # EOF  # bad # rubocop:disable Layout/SpaceAroundOperators x= 0 # EOF
# Lint/MissingCopEnableDirective: # MaximumRangeSize: 2  # good # rubocop:disable Layout/SpaceAroundOperators x= 0 # With the previous, there are 2 lines on which cop is disabled. # rubocop:enable Layout/SpaceAroundOperators  # bad # rubocop:disable Layout/SpaceAroundOperators x= 0 x += 1 # Including this, that's 3 lines on which the cop is disabled. # rubocop:enable Layout/SpaceAroundOperators

Constant Summary collapse

MSG = 
'Re-enable %<cop>s %<type>s with `# rubocop:enable` after disabling it.'
MSG_BOUND = 
'Re-enable %<cop>s %<type>s within %<max_range>s lines after disabling it.'

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

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_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #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_new_investigation ⇒ Object 

 51 52 53 54 55 56 57 58 59
 
# File 'lib/rubocop/cop/lint/missing_cop_enable_directive.rb', line 51 def on_new_investigation each_missing_enable do |cop, line_range| next if acceptable_range?(cop, line_range) comment = processed_source.comment_at_line(line_range.begin) add_offense(comment, message: message(cop, comment)) end end