Skip to main content

PropertyWithRequiredAndDefault

All Cookstyle Cops


The department is: Chef/RedundantCode

The full name of the cop is: Chef/RedundantCode/PropertyWithRequiredAndDefault


Enabled by defaultSupports autocorrectionTarget Chef Version
EnabledYesAll Versions

When using properties in a custom resource you shouldn’t set a property to required and then provide a default value. If a property is required the user will always pass in a value and the default will never be used. In Chef Infra Client 13+ this became an error.

Examples

incorrect

property :bob, String, required: true, default: 'foo'

correct

property :bob, String, required: true

Configurable attributes

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

Was this page helpful?