Class: RuboCop::Cop::Style::LeadingCommentSpace

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/leading_comment_space.rb

Overview

This cop checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, etc. Neither is it required for =begin/=end comments.

Constant Summary collapse

MSG = 
'Missing space after #.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(comment) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/rubocop/cop/style/leading_comment_space.rb', line 23

def autocorrect(comment)
  expr = comment.loc.expression
  b = expr.begin_pos
  hash_mark = Parser::Source::Range.new(expr.source_buffer, b, b + 1)
  ->(corrector) { corrector.insert_after(hash_mark, ' ') }
end

#investigate(processed_source) ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/rubocop/cop/style/leading_comment_space.rb', line 14

def investigate(processed_source)
  processed_source.comments.each do |comment|
    next unless comment.text =~ /\A#+[^#\s=:+-]/
    next if comment.text.start_with?('#!') && comment.loc.line == 1

    add_offense(comment, :expression)
  end
end