Class: RuboCop::Cop::Lint::UnneededCopEnableDirective
- Includes:
- RangeHelp, SurroundingSpace
- Defined in:
- lib/rubocop/cop/lint/unneeded_cop_enable_directive.rb
Overview
This cop detects instances of rubocop:enable comments that can be removed.
When comment enables all cops at once ‘rubocop:enable all` that cop checks whether any cop was actually enabled.
Constant Summary collapse
- MSG =
'Unnecessary enabling of %<cop>s.'
Constants included from SurroundingSpace
SurroundingSpace::NO_SPACE_COMMAND, SurroundingSpace::SPACE_COMMAND
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
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 AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #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
Instance Method Details
#autocorrect(comment_and_name) ⇒ Object
54 55 56 57 58 |
# File 'lib/rubocop/cop/lint/unneeded_cop_enable_directive.rb', line 54 def autocorrect(comment_and_name) lambda do |corrector| corrector.remove(range_with_comma(*comment_and_name)) end end |
#investigate(processed_source) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/rubocop/cop/lint/unneeded_cop_enable_directive.rb', line 41 def investigate(processed_source) return if processed_source.blank? offenses = processed_source.comment_config.extra_enabled_comments offenses.each do |comment, name| add_offense( [comment, name], location: range_of_offense(comment, name), message: format(MSG, cop: all_or_name(name)) ) end end |