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.

Constant Summary collapse

MSG = 
'Missing space after #.'

Instance Attribute Summary

Attributes inherited from Cop

#autocorrect, #corrections, #debug, #disabled_lines, #offences

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, all, #autocorrect_action, cop_name, cop_type, #do_autocorrect, #ignore_node, inherited, #initialize, lint?, #name, rails?, style?

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object 



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

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