Sha256: ee4c955608e43083a475b259642f01f2c7cbabfa45db2335b90dc648b79e26c1
Contents?: true
Size: 1.6 KB
Versions: 6
Compression:
Stored size: 1.6 KB
Contents
# frozen_string_literal: true
#
# Copyright:: 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 ChefRedundantCode
# The long_description metadata.rb method is not used and is unnecessary in cookbooks.
#
# @example
#
# # bad
# long_description 'this is my cookbook and this description will never be seen'
#
class LongDescriptionMetadata < Cop
include RangeHelp
include RuboCop::Chef::AutocorrectHelpers
MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'
def on_send(node)
add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
end
def autocorrect(node)
lambda do |corrector|
corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
end
end
end
end
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems