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

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

AllowRBSInlineAnnotation: false (default)

 # bad  include Enumerable #[Integer]  attr_reader :name #: String attr_reader :age #: Integer?  #: ( #| Integer, #| String #| ) -> void def foo; end

AllowRBSInlineAnnotation: true

 # good  include Enumerable #[Integer]  attr_reader :name #: String attr_reader :age #: Integer?  #: ( #| Integer, #| String #| ) -> void def foo; end

AllowSteepAnnotation: false (default)

 # bad [1, 2, 3].each_with_object([]) do |n, list| #$ Array[Integer]  list << n end name = 'John' #: String

AllowSteepAnnotation: true

 # good  [1, 2, 3].each_with_object([]) do |n, list| #$ Array[Integer]  list << n end name = 'John' #: String

Constant Summary collapse

MSG = 
'Missing space after `#`.'

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_new_investigation ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
 
# File 'lib/rubocop/cop/layout/leading_comment_space.rb', line 107 def on_new_investigation # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity  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 shebang_continuation?(comment) next if doxygen_comment_style?(comment) next if gemfile_ruby_comment?(comment) next if rbs_inline_annotation?(comment) next if steep_annotation?(comment) add_offense(comment) do |corrector| expr = comment.source_range corrector.insert_after(hash_mark(expr), ' ') end end end