Class: Rubocop::Cop::Style::LeadingCommentSpace
- 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 #.'
Constants inherited from Cop
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offences, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, #initialize, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning
Constructor Details
This class inherits a constructor from Rubocop::Cop::Cop
Instance Method Details
#autocorrect(comment) ⇒ Object
23 24 25 26 27 28 29 30 |
# 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) @corrections << lambda do |corrector| corrector.insert_after(hash_mark, ' ') end end |
#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 convention(comment, :expression) end end end end |