Class: RuboCop::Cop::Layout::LeadingCommentSpace
- 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.
Constant Summary collapse
- MSG =
'Missing space after `#`.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #target_ruby_version
Methods included from AST::Sexp
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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(comment) ⇒ Object
33 34 35 36 37 38 |
# File 'lib/rubocop/cop/layout/leading_comment_space.rb', line 33 def autocorrect(comment) expr = comment.loc.expression hash_mark = range_between(expr.begin_pos, expr.begin_pos + 1) ->(corrector) { corrector.insert_after(hash_mark, ' ') } end |
#investigate(processed_source) ⇒ Object
24 25 26 27 28 29 30 31 |
# File 'lib/rubocop/cop/layout/leading_comment_space.rb', line 24 def investigate(processed_source) processed_source.each_comment do |comment| next unless comment.text =~ /\A#+[^#\s=:+-]/ next if comment.loc.line == 1 && allowed_on_first_line?(comment) add_offense(comment) end end |