Class: RuboCop::Cop::Layout::LeadingCommentSpace

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/layout/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`, `=begin`- and `=end` comments, “shebang” directives, or rackup options.

Examples:


# bad
#Some comment

# good
# Some comment

AllowDoxygenCommentStyle: false (default)


# bad

#**
# Some comment
# Another line of comment
#*

AllowDoxygenCommentStyle: true


# good

#**
# Some comment
# Another line of comment
#*

AllowGemfileRubyComment: false (default)


# bad

#ruby=2.7.0
#ruby-gemset=myproject

AllowGemfileRubyComment: true


# good

#ruby=2.7.0
#ruby-gemset=myproject

Constant Summary collapse

MSG =
'Missing space after `#`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_new_investigationObject


58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/rubocop/cop/layout/leading_comment_space.rb', line 58

def on_new_investigation
  processed_source.comments.each do |comment|
    next unless /\A#+[^#\s=:+-]/.match?(comment.text)
    next if comment.loc.line == 1 && allowed_on_first_line?(comment)
    next if doxygen_comment_style?(comment)
    next if gemfile_ruby_comment?(comment)

    add_offense(comment) do |corrector|
      expr = comment.loc.expression

      corrector.insert_after(hash_mark(expr), ' ')
    end
  end
end