Sha256: 55988f2dad71b3997e191fe2fa0c8bf3e640df636905bfef6a959922af6f122a

Contents?: true

Size: 1.5 KB

Versions: 8

Compression:

Stored size: 1.5 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 < Base
          extend AutoCorrector

          MSG = 'Remove legacy code comments that disable Foodcritic rules'

          def on_new_investigation
            processed_source.comments.each do |comment|
              next unless comment.text.match?(/#\s*~FC\d{3}.*/)
              add_offense(comment, message: MSG, severity: :refactor) do |corrector|
                corrector.remove(comment.loc.expression)
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
cookstyle-6.18.8 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.17.7 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.17.6 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.17.5 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.16.10 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.16.9 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.16.7 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb
cookstyle-6.16.4 lib/rubocop/cop/chef/modernize/foodcritic_comments.rb