Sha256: be1ec26dfad7e4087aee96331bc4c2405cc09e48f1c8aaa033f8033b1cf8ef3e

Contents?: true

Size: 1.5 KB

Versions: 36

Compression:

Stored size: 1.5 KB

Contents

#
# Copyright:: 2016-2019, Chef Software, Inc.
# Author:: Tim Smith (<tsmith@chef.io>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

module RuboCop
  module Cop
    module Chef
      module ChefStyle
        # Replaces double spaces between sentences with a single space.
        # Note: This is DISABLED by default.
        class CommentSentenceSpacing < Cop
          MSG = 'Use a single space after sentences in comments'.freeze

          def investigate(processed_source)
            return unless processed_source.ast

            processed_source.comments.each do |comment|
              if comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
              end
            end
          end

          def autocorrect(comment)
            ->(corrector) { corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? ')) }
          end
        end
      end
    end
  end
end

Version data entries

36 entries across 36 versions & 1 rubygems

Version Path
cookstyle-6.11.4 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.10.2 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.9.0 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.8.0 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.7.3 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.6.9 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.5.3 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.4.4 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.23.0 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.3.4 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.2.9 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.2.5 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.1.6 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-6.0.19 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.22.6 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.21.9 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.20.0 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.19.9 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.18.4 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb
cookstyle-5.17.4 lib/rubocop/cop/chef/style/comment_sentence_spacing.rb