PropertyWithRequiredAndDefault
The department is: PropertyWithRequiredAndDefault
The full name of the cop is: Chef/RedundantCode/PropertyWithRequiredAndDefault
| Enabled by default | Supports autocorrection | Target Chef Version |
|---|---|---|
| Enabled | Yes | All 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
| Name | Default value | Configurable values |
|---|---|---|
| Version Added | 5.1.0 | String |
| Include |
| Array |
Was this page helpful?