Sha256: d896c88ad62ef0944ea56a1facad60c8f9f66a5038d39c6024ee0b870daf94c3
Contents?: true
Size: 1.76 KB
Versions: 35
Compression:
Stored size: 1.76 KB
Contents
# frozen_string_literal: true
#
# Copyright:: Copyright 2020, 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 Sharing
# Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
#
# @example
#
# #### correct
# resource_name :foo
# description "The foo resource is used to do..."
#
class IncludeResourceDescriptions < Base
include RangeHelp
extend TargetChefVersion
minimum_target_chef_version '13.9'
MSG = 'Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
def on_new_investigation
return if processed_source.blank? || resource_description(processed_source.ast).any?
# Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
range = source_range(processed_source.buffer, 1, 0)
add_offense(range, message: MSG, severity: :refactor)
end
def_node_search :resource_description, '(send nil? :description ...)'
end
end
end
end
end
Version data entries
35 entries across 35 versions & 1 rubygems