Sha256: 92e9fa5d12a1caa18f1a2b4691c1e5becceaa1cbc838257925c28a59944460b9

Contents?: true

Size: 1.61 KB

Versions: 6

Compression:

Stored size: 1.61 KB

Contents

# frozen_string_literal: true
#
# 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 ChefModernize
        # Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
        #
        # @example
        #
        #   # bad
        #   # ~FC013
        #
        class FoodcriticComments < Cop
          MSG = 'Remove legacy code comments that disable Foodcritic rules'

          def investigate(processed_source)
            return unless processed_source.ast

            processed_source.comments.each do |comment|
              if comment.text.match?(/#\s*~FC\d{3}.*/)
                add_offense(comment, location: :expression, message: MSG, severity: :refactor)
              end
            end
          end

          def autocorrect(node)
            lambda do |corrector|
              corrector.remove(node.loc.expression)
            end
          end
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
cookstyle-6.15.9 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.15.5 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.15.3 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.14.7 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.13.3 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.12.6 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb