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 #.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, 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_ruby_version

Methods included from AST::Sexp

#s

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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(comment) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/rubocop/cop/style/leading_comment_space.rb', line 28

def autocorrect(comment)
  expr = comment.loc.expression
  b = expr.begin_pos
  hash_mark = range_between(b, b + 1)
  ->(corrector) { corrector.insert_after(hash_mark, ' ') }
end

#investigate(processed_source) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
 
# 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

    # in config.ru files, if the first line starts with #\ it is treated
    # as options (e.g. `#\ -p 8765` sets the request port to 8765)
    next if comment.text.start_with?('#\\') && comment.loc.line == 1 &&
            config_ru?(processed_source.buffer.name)

    add_offense(comment, :expression)
  end
end