config/cookstyle.yml in cookstyle-6.13.3 vs config/cookstyle.yml in cookstyle-6.14.7
- old
+ new
@@ -3,31 +3,10 @@
TargetChefVersion: ~
Exclude:
- '/**/files/**/*'
- '/**/vendor/**/*'
- Guardfile
- ChefAttributes:
- Patterns:
- - attributes/.*\.rb
- ChefDefinitions:
- Patterns:
- - definitions/.*\.rb
- ChefLibraries:
- Patterns:
- - libraries/.*\.rb
- ChefMetadata:
- Patterns:
- - metadata\.rb
- ChefProviders:
- Patterns:
- - providers/.*\.rb
- ChefRecipes:
- Patterns:
- - recipes/.*\.rb
- ChefResources:
- Patterns:
- - resources/.*\.rb
###############################
# ChefStyle: Making cookbooks look better
###############################
@@ -65,11 +44,11 @@
VersionAdded: '5.0.0'
Exclude:
- '**/Berksfile'
ChefStyle/FileMode:
- Description: Use strings to represent file modes in Chef resources
+ Description: Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
StyleGuide: '#chefstylefilemode'
Enabled: true
VersionAdded: '5.0.0'
Exclude:
- '**/attributes/*'
@@ -469,10 +448,19 @@
Enabled: true
VersionAdded: '6.13.0'
Include:
- '**/metadata.rb'
+ChefCorrectness/MacosUserdefaultsInvalidType:
+ Description: The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are 'array', 'bool', 'dict', 'float', 'int', and 'string'.
+ StyleGuide: '#chefcorrectnessmacosuserdefaultsinvalidtype'
+ Enabled: true
+ VersionAdded: '6.14.0'
+ Exclude:
+ - '**/metadata.rb'
+ - '**/Berksfile'
+
###############################
# ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
###############################
ChefSharing:
@@ -513,28 +501,28 @@
VersionChanged: '5.15.0'
Include:
- '**/metadata.rb'
ChefSharing/IncludePropertyDescriptions:
- Description: Properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+ Description: Properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
StyleGuide: '#chefsharingincludepropetydescriptions'
Enabled: false
VersionAdded: '6.1.0'
Include:
- '**/libraries/*.rb'
- '**/resources/*.rb'
ChefSharing/IncludeResourceDescriptions:
- Description: Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+ Description: Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
StyleGuide: '#chefsharingincluderesourcedescriptions'
Enabled: false
VersionAdded: '6.1.0'
Include:
- '**/resources/*.rb'
ChefSharing/IncludeResourceExamples:
- Description: Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
+ Description: Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
StyleGuide: '#chefsharingincluderesourceexamples'
Enabled: false
VersionAdded: '6.10.0'
Include:
- '**/resources/*.rb'
@@ -1037,35 +1025,44 @@
- '**/libraries/*.rb'
- '**/resources/*.rb'
ChefDeprecations/ChefDKGenerators:
Description: Chef Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
- StyleGuide: '#chefdkgenerators'
+ StyleGuide: '#chefdeprecationschefdkgenerators'
Enabled: true
VersionAdded: '6.12.0'
Exclude:
- '**/metadata.rb'
- '**/Berksfile'
ChefDeprecations/ChefHandlerRecipe:
Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
- StyleGuide: '#chefhandlerrecipe'
+ StyleGuide: '#chefdeprecationschefhandlerrecipe'
Enabled: true
VersionAdded: '6.12.0'
Exclude:
- '**/metadata.rb'
- '**/Berksfile'
ChefDeprecations/UseAutomaticResourceName:
Description: The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
- StyleGuide: '#useautomaticresourcename'
+ StyleGuide: '#chefdeprecationsuseautomaticresourcename'
Enabled: true
VersionAdded: '6.12.0'
Include:
- '**/libraries/*.rb'
- '**/resources/*.rb'
+ChefDeprecations/MacosUserdefaultsGlobalProperty:
+ Description: The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. Omitting the `domain` property will now set global defaults.
+ StyleGuide: '#chefdeprecationsmacosuserdefaultsglobalproperty'
+ Enabled: true
+ VersionAdded: '6.14.0'
+ Exclude:
+ - '**/metadata.rb'
+ - '**/Berksfile'
+
###############################
# ChefModernize: Cleaning up legacy code and using new built-in resources
###############################
ChefModernize:
@@ -1538,11 +1535,11 @@
- '**/metadata.rb'
- '**/attributes/*.rb'
- '**/Berksfile'
ChefModernize/UseMultipackageInstalls:
- Description: Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.
+ Description: Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
StyleGuide: '#chefmodernizeusemultipackageinstalls'
Enabled: true
VersionAdded: '6.0.0'
Exclude:
- '**/metadata.rb'
@@ -1871,10 +1868,10 @@
VersionAdded: '5.1.0'
Exclude:
- '**/metadata.rb'
- '**/Berksfile'
-ChefEffortless/CookbookUsesEnvironmments:
+ChefEffortless/CookbookUsesEnvironments:
Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
StyleGuide: '#chefeffortlesscookbookusesenvironments'
Enabled: false
VersionAdded: '5.10.0'
Exclude: