Skip to main content

ResourceInheritsFromCompatResource

All Cookstyle Cops


The department is: Chef/Deprecations

The full name of the cop is: Chef/Deprecations/ResourceInheritsFromCompatResource


Enabled by defaultSupports autocorrectionTarget Chef Version
EnabledYesAll Versions

Resources written in the class based HWRP style should inherit from the ‘Chef::Resource’ class and not the ‘ChefCompat::Resource’ class from the deprecated compat_resource cookbook.

Examples

incorrect

class AptUpdate < ChefCompat::Resource
  # some resource code
end

correct

class AptUpdate < Chef::Resource
  # some resource code
end

# better
Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely

Configurable attributes

NameDefault valueConfigurable values
Version Added5.10.0String
Include
  • **/libraries/*.rb
Array

Was this page helpful?