cookstyle 7.8.0 → 7.8.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/config/cookstyle.yml +229 -228
- data/lib/cookstyle/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e04dd24b5b97c48a31e63a92a6d333c5c43bc4a4548d7f478a1568c3a6852f04
|
4
|
+
data.tar.gz: c03fcc110f131b4d0d4d094d13e8d3f7027c3f995d19e9b31f7ef37308e112e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 85afba2dca8cf6626f58c7cb42ce79f2e9b41c9f2e4eef8833988130d1cb4376de34942ad8fb4337271f5c4b6b15f5e32f31443620227c719379f993850dd34d
|
7
|
+
data.tar.gz: a4a02a5e22bdd2b39d2b867c7a669a24fb4b324558ed6073971674f1155323736aac2bb1446fa73e0c073b6e84a36a96a6c0986d1e027feb73fcd4ec9f953c18
|
data/config/cookstyle.yml
CHANGED
@@ -12,11 +12,11 @@ AllCops:
|
|
12
12
|
###############################
|
13
13
|
|
14
14
|
Chef/Style:
|
15
|
-
StyleGuideBaseURL: https://
|
15
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
16
16
|
|
17
17
|
Chef/Style/AttributeKeys:
|
18
18
|
Description: Check which style of keys are used to access node attributes.
|
19
|
-
StyleGuide: '
|
19
|
+
StyleGuide: 'chef_style_attributekeys'
|
20
20
|
Enabled: true
|
21
21
|
EnforcedStyle: strings
|
22
22
|
VersionAdded: '5.0.0'
|
@@ -28,19 +28,19 @@ Chef/Style/AttributeKeys:
|
|
28
28
|
|
29
29
|
Chef/Style/CopyrightCommentFormat:
|
30
30
|
Description: Properly format copyright dates in comment blocks and ensure dates are up to date
|
31
|
-
StyleGuide: '
|
31
|
+
StyleGuide: 'chef_style_copyrightcommentformat'
|
32
32
|
Enabled: false
|
33
33
|
VersionAdded: '5.0.0'
|
34
34
|
|
35
35
|
Chef/Style/CommentSentenceSpacing:
|
36
36
|
Description: Use a single space after sentences in comments
|
37
|
-
StyleGuide: '
|
37
|
+
StyleGuide: 'chef_style_commentsentencespacing'
|
38
38
|
Enabled: false
|
39
39
|
VersionAdded: '5.1.0'
|
40
40
|
|
41
41
|
Chef/Style/CommentFormat:
|
42
42
|
Description: Use Chef's unique format for comment headers
|
43
|
-
StyleGuide: '
|
43
|
+
StyleGuide: 'chef_style_commentformat'
|
44
44
|
Enabled: true
|
45
45
|
VersionAdded: '5.0.0'
|
46
46
|
Exclude:
|
@@ -48,7 +48,7 @@ Chef/Style/CommentFormat:
|
|
48
48
|
|
49
49
|
Chef/Style/FileMode:
|
50
50
|
Description: Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
|
51
|
-
StyleGuide: '
|
51
|
+
StyleGuide: 'chef_style_filemode'
|
52
52
|
Enabled: true
|
53
53
|
VersionAdded: '5.0.0'
|
54
54
|
Exclude:
|
@@ -58,7 +58,7 @@ Chef/Style/FileMode:
|
|
58
58
|
|
59
59
|
Chef/Style/UsePlatformHelpers:
|
60
60
|
Description: Use platform? and platform_family? helpers to check node platform in resources and recipes
|
61
|
-
StyleGuide: '
|
61
|
+
StyleGuide: 'chef_style_useplatformhelpers'
|
62
62
|
Enabled: true
|
63
63
|
VersionAdded: '5.6.0'
|
64
64
|
Exclude:
|
@@ -68,7 +68,7 @@ Chef/Style/UsePlatformHelpers:
|
|
68
68
|
|
69
69
|
Chef/Style/SimplifyPlatformMajorVersionCheck:
|
70
70
|
Description: Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]
|
71
|
-
StyleGuide: '
|
71
|
+
StyleGuide: 'chef_style_simplifyplatformmajorversioncheck'
|
72
72
|
Enabled: true
|
73
73
|
VersionAdded: '5.8.0'
|
74
74
|
Exclude:
|
@@ -77,13 +77,13 @@ Chef/Style/SimplifyPlatformMajorVersionCheck:
|
|
77
77
|
|
78
78
|
Chef/Style/DefaultCopyrightComments:
|
79
79
|
Description: Cookbook copyright comment headers should be updated for a real person or organization.
|
80
|
-
StyleGuide: '
|
80
|
+
StyleGuide: 'chef_style_defaultcopyrightcomments'
|
81
81
|
Enabled: true
|
82
82
|
VersionAdded: '5.12.0'
|
83
83
|
|
84
84
|
Chef/Style/UnnecessaryPlatformCaseStatement:
|
85
85
|
Description: Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.
|
86
|
-
StyleGuide: '
|
86
|
+
StyleGuide: 'chef_style_unnecessaryplatformcasestatement'
|
87
87
|
Enabled: true
|
88
88
|
VersionAdded: '5.16.0'
|
89
89
|
Exclude:
|
@@ -92,7 +92,7 @@ Chef/Style/UnnecessaryPlatformCaseStatement:
|
|
92
92
|
|
93
93
|
Chef/Style/ImmediateNotificationTiming:
|
94
94
|
Description: Use :immediately instead of :immediate for resource notification timing.
|
95
|
-
StyleGuide: '
|
95
|
+
StyleGuide: 'chef_style_immediatenotificationtiming'
|
96
96
|
Enabled: true
|
97
97
|
VersionAdded: '5.16.0'
|
98
98
|
Exclude:
|
@@ -102,7 +102,7 @@ Chef/Style/ImmediateNotificationTiming:
|
|
102
102
|
|
103
103
|
Chef/Style/TrueClassFalseClassResourceProperties:
|
104
104
|
Description: When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.
|
105
|
-
StyleGuide: '
|
105
|
+
StyleGuide: 'chef_style_trueclassfalseclassresourceproperties'
|
106
106
|
Enabled: true
|
107
107
|
VersionAdded: '5.16.0'
|
108
108
|
Include:
|
@@ -111,7 +111,7 @@ Chef/Style/TrueClassFalseClassResourceProperties:
|
|
111
111
|
|
112
112
|
Chef/Style/OverlyComplexSupportsDependsMetadata:
|
113
113
|
Description: Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set.
|
114
|
-
StyleGuide: '
|
114
|
+
StyleGuide: 'chef_style_overcomplexsupportsdependsmetadata'
|
115
115
|
Enabled: true
|
116
116
|
VersionAdded: '5.19.0'
|
117
117
|
Include:
|
@@ -119,13 +119,13 @@ Chef/Style/OverlyComplexSupportsDependsMetadata:
|
|
119
119
|
|
120
120
|
Chef/Style/ChefWhaaat:
|
121
121
|
Description: Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?
|
122
|
-
StyleGuide: '
|
122
|
+
StyleGuide: 'chef_style_chefwhaaat'
|
123
123
|
Enabled: false
|
124
124
|
VersionAdded: '5.20.0'
|
125
125
|
|
126
126
|
Chef/Style/UnnecessaryOSCheck:
|
127
127
|
Description: Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic.
|
128
|
-
StyleGuide: '
|
128
|
+
StyleGuide: 'chef_style_unnecessaryoscheck'
|
129
129
|
Enabled: true
|
130
130
|
VersionAdded: '5.21.0'
|
131
131
|
Exclude:
|
@@ -134,7 +134,7 @@ Chef/Style/UnnecessaryOSCheck:
|
|
134
134
|
|
135
135
|
Chef/Style/NegatingOnlyIf:
|
136
136
|
Description: Use not_if instead of only_if that negates the Ruby statement with a !
|
137
|
-
StyleGuide: '
|
137
|
+
StyleGuide: 'chef_style_negatingonlyif'
|
138
138
|
VersionAdded: '6.2.0'
|
139
139
|
Enabled: true
|
140
140
|
Exclude:
|
@@ -156,11 +156,11 @@ Chef/Style/IncludeRecipeWithParentheses:
|
|
156
156
|
###############################
|
157
157
|
|
158
158
|
Chef/Correctness:
|
159
|
-
StyleGuideBaseURL: https://
|
159
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
160
160
|
|
161
161
|
Chef/Correctness/ServiceResource:
|
162
162
|
Description: Use a service resource to start and stop services instead of execute resources
|
163
|
-
StyleGuide: '
|
163
|
+
StyleGuide: 'chef_correctness_serviceresource'
|
164
164
|
Enabled: true
|
165
165
|
VersionAdded: '5.0.0'
|
166
166
|
Exclude:
|
@@ -170,7 +170,7 @@ Chef/Correctness/ServiceResource:
|
|
170
170
|
|
171
171
|
Chef/Correctness/NodeNormal:
|
172
172
|
Description: Do not use the node.normal method
|
173
|
-
StyleGuide: '
|
173
|
+
StyleGuide: 'chef_correctness_nodenormal'
|
174
174
|
Enabled: true
|
175
175
|
VersionAdded: '5.1.0'
|
176
176
|
Exclude:
|
@@ -179,6 +179,7 @@ Chef/Correctness/NodeNormal:
|
|
179
179
|
|
180
180
|
Chef/Correctness/NodeNormalUnless:
|
181
181
|
Description: Do not use the node.normal_unless method
|
182
|
+
StyleGuide: 'chef_correctness_chernodenormalunless'
|
182
183
|
Enabled: true
|
183
184
|
VersionAdded: '5.1.0'
|
184
185
|
Exclude:
|
@@ -187,7 +188,7 @@ Chef/Correctness/NodeNormalUnless:
|
|
187
188
|
|
188
189
|
Chef/Correctness/TmpPath:
|
189
190
|
Description: Use file_cache_path rather than hard-coding tmp paths
|
190
|
-
StyleGuide: '
|
191
|
+
StyleGuide: 'chef_correctness_nodenormalunless'
|
191
192
|
Enabled: true
|
192
193
|
VersionAdded: '5.0.0'
|
193
194
|
Exclude:
|
@@ -196,7 +197,7 @@ Chef/Correctness/TmpPath:
|
|
196
197
|
|
197
198
|
Chef/Correctness/InvalidPlatformMetadata:
|
198
199
|
Description: metadata.rb "supports" platform is invalid
|
199
|
-
StyleGuide: '
|
200
|
+
StyleGuide: 'chef_correctness_invalidplatformmetadata'
|
200
201
|
Enabled: true
|
201
202
|
VersionAdded: '5.2.0'
|
202
203
|
Include:
|
@@ -204,7 +205,7 @@ Chef/Correctness/InvalidPlatformMetadata:
|
|
204
205
|
|
205
206
|
Chef/Correctness/CookbookUsesNodeSave:
|
206
207
|
Description: Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server.
|
207
|
-
StyleGuide: '
|
208
|
+
StyleGuide: 'chef_correctness_cookbookusesnodesave'
|
208
209
|
Enabled: true
|
209
210
|
VersionAdded: '5.5.0'
|
210
211
|
Exclude:
|
@@ -213,7 +214,7 @@ Chef/Correctness/CookbookUsesNodeSave:
|
|
213
214
|
|
214
215
|
Chef/Correctness/MetadataMissingName:
|
215
216
|
Description: The metadata.rb file is missing the name field which is required by Chef Infra Client 12 and later
|
216
|
-
StyleGuide: '
|
217
|
+
StyleGuide: 'chef_correctness_metadatamissingname'
|
217
218
|
Enabled: true
|
218
219
|
VersionAdded: '5.2.0'
|
219
220
|
Include:
|
@@ -221,7 +222,7 @@ Chef/Correctness/MetadataMissingName:
|
|
221
222
|
|
222
223
|
Chef/Correctness/BlockGuardWithOnlyString:
|
223
224
|
Description: A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.
|
224
|
-
StyleGuide: '
|
225
|
+
StyleGuide: 'chef_correctness_blockguardwithonlystring'
|
225
226
|
Enabled: true
|
226
227
|
VersionAdded: '5.2.0'
|
227
228
|
Exclude:
|
@@ -231,7 +232,7 @@ Chef/Correctness/BlockGuardWithOnlyString:
|
|
231
232
|
|
232
233
|
Chef/Correctness/ResourceSetsInternalProperties:
|
233
234
|
Description: Do not set properties used internally by Chef Infra Client to track the system state.
|
234
|
-
StyleGuide: '
|
235
|
+
StyleGuide: 'chef_correctness_resourcesetsinternalproperties'
|
235
236
|
Enabled: true
|
236
237
|
VersionAdded: '5.5.0'
|
237
238
|
Exclude:
|
@@ -241,7 +242,7 @@ Chef/Correctness/ResourceSetsInternalProperties:
|
|
241
242
|
|
242
243
|
Chef/Correctness/ResourceSetsNameProperty:
|
243
244
|
Description: Resource sets the name property in the resource instead of using a name_property.
|
244
|
-
StyleGuide: '
|
245
|
+
StyleGuide: 'chef_correctness_resourcesetsnameproperty'
|
245
246
|
Enabled: true
|
246
247
|
VersionAdded: '5.5.0'
|
247
248
|
Exclude:
|
@@ -251,7 +252,7 @@ Chef/Correctness/ResourceSetsNameProperty:
|
|
251
252
|
|
252
253
|
Chef/Correctness/ResourceWithNoneAction:
|
253
254
|
Description: Resource uses the nonexistent :none action instead of the :nothing action
|
254
|
-
StyleGuide: '
|
255
|
+
StyleGuide: 'chef_correctness_resourcewithnoneaction'
|
255
256
|
Enabled: true
|
256
257
|
VersionAdded: '5.5.0'
|
257
258
|
Exclude:
|
@@ -261,7 +262,7 @@ Chef/Correctness/ResourceWithNoneAction:
|
|
261
262
|
|
262
263
|
Chef/Correctness/InvalidVersionMetadata:
|
263
264
|
Description: Cookbook metadata.rb version field should follow X.Y.Z version format.
|
264
|
-
StyleGuide: '
|
265
|
+
StyleGuide: 'chef_correctness_invalidversionmetadata'
|
265
266
|
Enabled: true
|
266
267
|
VersionAdded: '5.8.0'
|
267
268
|
Include:
|
@@ -269,7 +270,7 @@ Chef/Correctness/InvalidVersionMetadata:
|
|
269
270
|
|
270
271
|
Chef/Correctness/NotifiesActionNotSymbol:
|
271
272
|
Description: When notifying or subscribing an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
|
272
|
-
StyleGuide: '
|
273
|
+
StyleGuide: 'chef_correctness_notifiesactionnotsymbol'
|
273
274
|
Enabled: true
|
274
275
|
VersionAdded: '5.10.0'
|
275
276
|
Exclude:
|
@@ -279,7 +280,7 @@ Chef/Correctness/NotifiesActionNotSymbol:
|
|
279
280
|
|
280
281
|
Chef/Correctness/IncorrectLibraryInjection:
|
281
282
|
Description: Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.
|
282
|
-
StyleGuide: '
|
283
|
+
StyleGuide: 'chef_correctness_incorrectlibraryinjection'
|
283
284
|
Enabled: true
|
284
285
|
VersionAdded: '5.10.0'
|
285
286
|
Exclude:
|
@@ -288,7 +289,7 @@ Chef/Correctness/IncorrectLibraryInjection:
|
|
288
289
|
|
289
290
|
Chef/Correctness/InvalidPlatformHelper:
|
290
291
|
Description: Pass valid platforms to the platform? helper.
|
291
|
-
StyleGuide: '
|
292
|
+
StyleGuide: 'chef_correctness_invalidplatformhelper'
|
292
293
|
Enabled: true
|
293
294
|
VersionAdded: '5.15.0'
|
294
295
|
Exclude:
|
@@ -297,7 +298,7 @@ Chef/Correctness/InvalidPlatformHelper:
|
|
297
298
|
|
298
299
|
Chef/Correctness/InvalidPlatformFamilyHelper:
|
299
300
|
Description: Pass valid platform families to the platform_family? helper.
|
300
|
-
StyleGuide: '
|
301
|
+
StyleGuide: 'chef_correctness_invalidplatformfamilyhelper'
|
301
302
|
Enabled: true
|
302
303
|
VersionAdded: '5.15.0'
|
303
304
|
Exclude:
|
@@ -306,7 +307,7 @@ Chef/Correctness/InvalidPlatformFamilyHelper:
|
|
306
307
|
|
307
308
|
Chef/Correctness/ScopedFileExist:
|
308
309
|
Description: Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
|
309
|
-
StyleGuide: '
|
310
|
+
StyleGuide: 'chef_correctness_scopedfileexist'
|
310
311
|
Enabled: true
|
311
312
|
VersionAdded: '5.15.0'
|
312
313
|
Exclude:
|
@@ -316,7 +317,7 @@ Chef/Correctness/ScopedFileExist:
|
|
316
317
|
|
317
318
|
Chef/Correctness/InvalidPlatformValueForPlatformFamilyHelper:
|
318
319
|
Description: Pass valid platforms families to the value_for_platform_family helper.
|
319
|
-
StyleGuide: '
|
320
|
+
StyleGuide: 'chef_correctness_invalidplatformvalueforplatformfamilyhelper'
|
320
321
|
Enabled: true
|
321
322
|
VersionAdded: '5.15.0'
|
322
323
|
Exclude:
|
@@ -325,7 +326,7 @@ Chef/Correctness/InvalidPlatformValueForPlatformFamilyHelper:
|
|
325
326
|
|
326
327
|
Chef/Correctness/InvalidPlatformValueForPlatformHelper:
|
327
328
|
Description: Pass valid platforms to the value_for_platform helper.
|
328
|
-
StyleGuide: '
|
329
|
+
StyleGuide: 'chef_correctness_invalidplatformvalueforplatformhelper'
|
329
330
|
Enabled: true
|
330
331
|
VersionAdded: '5.15.0'
|
331
332
|
Exclude:
|
@@ -334,7 +335,7 @@ Chef/Correctness/InvalidPlatformValueForPlatformHelper:
|
|
334
335
|
|
335
336
|
Chef/Correctness/InvalidNotificationTiming:
|
336
337
|
Description: Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
|
337
|
-
StyleGuide: '
|
338
|
+
StyleGuide: 'chef_correctness_invalidnotificationtiming'
|
338
339
|
Enabled: true
|
339
340
|
VersionAdded: '5.16.0'
|
340
341
|
Exclude:
|
@@ -344,7 +345,7 @@ Chef/Correctness/InvalidNotificationTiming:
|
|
344
345
|
|
345
346
|
Chef/Correctness/MalformedPlatformValueForPlatformHelper:
|
346
347
|
Description: When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
|
347
|
-
StyleGuide: '
|
348
|
+
StyleGuide: 'chef_correctness_malformedplatformvalueforplatformhelper'
|
348
349
|
Enabled: true
|
349
350
|
VersionAdded: '5.16.0'
|
350
351
|
Exclude:
|
@@ -353,7 +354,7 @@ Chef/Correctness/MalformedPlatformValueForPlatformHelper:
|
|
353
354
|
|
354
355
|
Chef/Correctness/DnfPackageAllowDowngrades:
|
355
356
|
Description: dnf_package does not support the allow_downgrades property
|
356
|
-
StyleGuide: '
|
357
|
+
StyleGuide: 'chef_correctness_dnfpackageallowdowngrades'
|
357
358
|
Enabled: true
|
358
359
|
VersionAdded: '5.16.0'
|
359
360
|
Exclude:
|
@@ -363,7 +364,7 @@ Chef/Correctness/DnfPackageAllowDowngrades:
|
|
363
364
|
|
364
365
|
Chef/Correctness/ChefApplicationFatal:
|
365
366
|
Description: Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal
|
366
|
-
StyleGuide: '
|
367
|
+
StyleGuide: 'chef_correctness_chefapplicationfatal'
|
367
368
|
Enabled: true
|
368
369
|
VersionAdded: '6.0.0'
|
369
370
|
Exclude:
|
@@ -372,7 +373,7 @@ Chef/Correctness/ChefApplicationFatal:
|
|
372
373
|
|
373
374
|
Chef/Correctness/PowershellScriptDeleteFile:
|
374
375
|
Description: Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource
|
375
|
-
StyleGuide: '
|
376
|
+
StyleGuide: 'chef_correctness_powershellscriptdeletefiles'
|
376
377
|
Enabled: true
|
377
378
|
VersionAdded: '6.0.0'
|
378
379
|
Exclude:
|
@@ -382,7 +383,7 @@ Chef/Correctness/PowershellScriptDeleteFile:
|
|
382
383
|
|
383
384
|
Chef/Correctness/ConditionalRubyShellout:
|
384
385
|
Description: Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes.
|
385
|
-
StyleGuide: '
|
386
|
+
StyleGuide: 'chef_correctness_conditionalrubyshellout'
|
386
387
|
Enabled: true
|
387
388
|
VersionAdded: '6.1.0'
|
388
389
|
Exclude:
|
@@ -392,7 +393,7 @@ Chef/Correctness/ConditionalRubyShellout:
|
|
392
393
|
|
393
394
|
Chef/Correctness/LazyEvalNodeAttributeDefaults:
|
394
395
|
Description: When setting a node attribute as a default value for a custom resource property, make sure to wrap the node attribute in `lazy {}` so that the node attribute is available when the resource executes.
|
395
|
-
StyleGuide: '
|
396
|
+
StyleGuide: 'chef_correctness_lazyevalnodeattributedefaults'
|
396
397
|
Enabled: true
|
397
398
|
VersionAdded: '6.6.0'
|
398
399
|
Include:
|
@@ -401,7 +402,7 @@ Chef/Correctness/LazyEvalNodeAttributeDefaults:
|
|
401
402
|
|
402
403
|
Chef/Correctness/OpenSSLPasswordHelpers:
|
403
404
|
Description: The secure_password helper from the openssl cookbooks Opscode::OpenSSL::Password class should not be used to generate passwords.
|
404
|
-
StyleGuide: '
|
405
|
+
StyleGuide: 'chef_correctness_opensslpasswordhelpers'
|
405
406
|
Enabled: true
|
406
407
|
VersionAdded: '6.6.0'
|
407
408
|
Exclude:
|
@@ -410,7 +411,7 @@ Chef/Correctness/OpenSSLPasswordHelpers:
|
|
410
411
|
|
411
412
|
Chef/Correctness/InvalidPlatformFamilyInCase:
|
412
413
|
Description: Use valid platform family values in case statements.
|
413
|
-
StyleGuide: '
|
414
|
+
StyleGuide: 'chef_correctness_invalidplatformfamilyincase'
|
414
415
|
Enabled: true
|
415
416
|
VersionAdded: '6.6.0'
|
416
417
|
Exclude:
|
@@ -419,7 +420,7 @@ Chef/Correctness/InvalidPlatformFamilyInCase:
|
|
419
420
|
|
420
421
|
Chef/Correctness/InvalidPlatformInCase:
|
421
422
|
Description: Use valid platform values in case statements.
|
422
|
-
StyleGuide: '
|
423
|
+
StyleGuide: 'chef_correctness_invalidplatformincase'
|
423
424
|
Enabled: true
|
424
425
|
VersionAdded: '6.6.0'
|
425
426
|
Exclude:
|
@@ -428,7 +429,7 @@ Chef/Correctness/InvalidPlatformInCase:
|
|
428
429
|
|
429
430
|
Chef/Correctness/InvalidDefaultAction:
|
430
431
|
Description: Default actions in resources should be a symbol or an array of symbols.
|
431
|
-
StyleGuide: '
|
432
|
+
StyleGuide: 'chef_correctness_invaliddefaultaction'
|
432
433
|
Enabled: true
|
433
434
|
VersionAdded: '6.13.0'
|
434
435
|
Include:
|
@@ -437,7 +438,7 @@ Chef/Correctness/InvalidDefaultAction:
|
|
437
438
|
|
438
439
|
Chef/Correctness/SupportsMustBeFloat:
|
439
440
|
Description: Versions used in metadata.rb supports calls should be floats not integers.
|
440
|
-
StyleGuide: '
|
441
|
+
StyleGuide: 'chef_correctness_supportsmustbefloat'
|
441
442
|
Enabled: true
|
442
443
|
VersionAdded: '6.13.0'
|
443
444
|
Include:
|
@@ -445,7 +446,7 @@ Chef/Correctness/SupportsMustBeFloat:
|
|
445
446
|
|
446
447
|
Chef/Correctness/MacosUserdefaultsInvalidType:
|
447
448
|
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'.
|
448
|
-
StyleGuide: '
|
449
|
+
StyleGuide: 'chef_correctness_macosuserdefaultsinvalidtype'
|
449
450
|
Enabled: true
|
450
451
|
VersionAdded: '6.14.0'
|
451
452
|
Exclude:
|
@@ -454,7 +455,7 @@ Chef/Correctness/MacosUserdefaultsInvalidType:
|
|
454
455
|
|
455
456
|
Chef/Correctness/LazyInResourceGuard:
|
456
457
|
Description: Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
|
457
|
-
StyleGuide: '
|
458
|
+
StyleGuide: 'chef_correctness_lazyinresourceguard'
|
458
459
|
Enabled: true
|
459
460
|
VersionAdded: '6.18.0'
|
460
461
|
Exclude:
|
@@ -463,7 +464,7 @@ Chef/Correctness/LazyInResourceGuard:
|
|
463
464
|
|
464
465
|
Chef/Correctness/PropertyWithoutType:
|
465
466
|
Description: Custom resource properties or attributes should always define a type to help users understand the correct allowed values.
|
466
|
-
StyleGuide: '
|
467
|
+
StyleGuide: 'chef_correctness_propertywithouttype'
|
467
468
|
Enabled: true
|
468
469
|
VersionAdded: '6.18.0'
|
469
470
|
Include:
|
@@ -472,7 +473,7 @@ Chef/Correctness/PropertyWithoutType:
|
|
472
473
|
|
473
474
|
Chef/Correctness/OctalModeAsString:
|
474
475
|
Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
|
475
|
-
StyleGuide: '
|
476
|
+
StyleGuide: 'chef_correctness_octalmodeasstring'
|
476
477
|
Enabled: true
|
477
478
|
VersionAdded: '6.21.0'
|
478
479
|
Exclude:
|
@@ -485,11 +486,11 @@ Chef/Correctness/OctalModeAsString:
|
|
485
486
|
###############################
|
486
487
|
|
487
488
|
Chef/Sharing:
|
488
|
-
StyleGuideBaseURL: https://
|
489
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
489
490
|
|
490
491
|
Chef/Sharing/InsecureCookbookURL:
|
491
492
|
Description: Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields
|
492
|
-
StyleGuide: '
|
493
|
+
StyleGuide: 'chef_sharing_insecurecookbookurl'
|
493
494
|
Enabled: true
|
494
495
|
VersionAdded: '5.1.0'
|
495
496
|
VersionChanged: '5.15.0'
|
@@ -498,7 +499,7 @@ Chef/Sharing/InsecureCookbookURL:
|
|
498
499
|
|
499
500
|
Chef/Sharing/InvalidLicenseString:
|
500
501
|
Description: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved"
|
501
|
-
StyleGuide: '
|
502
|
+
StyleGuide: 'chef_sharing_invalidlicensestring'
|
502
503
|
Enabled: true
|
503
504
|
VersionAdded: '5.2.0'
|
504
505
|
VersionChanged: '5.15.0'
|
@@ -507,7 +508,7 @@ Chef/Sharing/InvalidLicenseString:
|
|
507
508
|
|
508
509
|
Chef/Sharing/DefaultMetadataMaintainer:
|
509
510
|
Description: Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.
|
510
|
-
StyleGuide: '
|
511
|
+
StyleGuide: 'chef_sharing_defaultmetadatamaintainer'
|
511
512
|
Enabled: true
|
512
513
|
VersionAdded: '5.4.0'
|
513
514
|
VersionChanged: '5.15.0'
|
@@ -516,7 +517,7 @@ Chef/Sharing/DefaultMetadataMaintainer:
|
|
516
517
|
|
517
518
|
Chef/Sharing/EmptyMetadataField:
|
518
519
|
Description: metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
|
519
|
-
StyleGuide: '
|
520
|
+
StyleGuide: 'chef_sharing_emptymetadatafield'
|
520
521
|
Enabled: true
|
521
522
|
VersionAdded: '5.8.0'
|
522
523
|
VersionChanged: '5.15.0'
|
@@ -525,7 +526,7 @@ Chef/Sharing/EmptyMetadataField:
|
|
525
526
|
|
526
527
|
Chef/Sharing/IncludePropertyDescriptions:
|
527
528
|
Description: Properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
528
|
-
StyleGuide: '
|
529
|
+
StyleGuide: 'chef_sharing_includepropetydescriptions'
|
529
530
|
Enabled: false
|
530
531
|
VersionAdded: '6.1.0'
|
531
532
|
Include:
|
@@ -534,7 +535,7 @@ Chef/Sharing/IncludePropertyDescriptions:
|
|
534
535
|
|
535
536
|
Chef/Sharing/IncludeResourceDescriptions:
|
536
537
|
Description: Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
537
|
-
StyleGuide: '
|
538
|
+
StyleGuide: 'chef_sharing_includeresourcedescriptions'
|
538
539
|
Enabled: false
|
539
540
|
VersionAdded: '6.1.0'
|
540
541
|
Include:
|
@@ -542,7 +543,7 @@ Chef/Sharing/IncludeResourceDescriptions:
|
|
542
543
|
|
543
544
|
Chef/Sharing/IncludeResourceExamples:
|
544
545
|
Description: Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
545
|
-
StyleGuide: '
|
546
|
+
StyleGuide: 'chef_sharing_includeresourceexamples'
|
546
547
|
Enabled: false
|
547
548
|
VersionAdded: '6.10.0'
|
548
549
|
Include:
|
@@ -553,11 +554,11 @@ Chef/Sharing/IncludeResourceExamples:
|
|
553
554
|
###############################
|
554
555
|
|
555
556
|
Chef/Deprecations:
|
556
|
-
StyleGuideBaseURL: https://
|
557
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
557
558
|
|
558
559
|
Chef/Deprecations/NodeDeepFetch:
|
559
560
|
Description: Do not use the deprecated chef-sugar node.deep_fetch methods
|
560
|
-
StyleGuide: '
|
561
|
+
StyleGuide: 'chef_deprecations_nodedeepfetch'
|
561
562
|
Enabled: true
|
562
563
|
VersionAdded: '5.12.0'
|
563
564
|
Exclude:
|
@@ -566,7 +567,7 @@ Chef/Deprecations/NodeDeepFetch:
|
|
566
567
|
|
567
568
|
Chef/Deprecations/NodeSet:
|
568
569
|
Description: Do not use the deprecated node.set method
|
569
|
-
StyleGuide: '
|
570
|
+
StyleGuide: 'chef_deprecations_nodeset'
|
570
571
|
Enabled: true
|
571
572
|
VersionAdded: '5.0.0'
|
572
573
|
Exclude:
|
@@ -575,7 +576,7 @@ Chef/Deprecations/NodeSet:
|
|
575
576
|
|
576
577
|
Chef/Deprecations/NodeSetUnless:
|
577
578
|
Description: Do not use the deprecated node.set_unless method
|
578
|
-
StyleGuide: '
|
579
|
+
StyleGuide: 'chef_deprecations_nodesetunless'
|
579
580
|
Enabled: true
|
580
581
|
VersionAdded: '5.1.0'
|
581
582
|
Exclude:
|
@@ -584,7 +585,7 @@ Chef/Deprecations/NodeSetUnless:
|
|
584
585
|
|
585
586
|
Chef/Deprecations/EpicFail:
|
586
587
|
Description: Use ignore_failure method instead of the deprecated epic_fail method
|
587
|
-
StyleGuide: '
|
588
|
+
StyleGuide: 'chef_deprecations_epicfail'
|
588
589
|
Enabled: true
|
589
590
|
VersionAdded: '5.1.0'
|
590
591
|
Exclude:
|
@@ -594,7 +595,7 @@ Chef/Deprecations/EpicFail:
|
|
594
595
|
|
595
596
|
Chef/Deprecations/CookbookDependsOnPoise:
|
596
597
|
Description: Cookbooks should not depend on the deprecated Poise framework
|
597
|
-
StyleGuide: '
|
598
|
+
StyleGuide: 'chef_deprecations_cookbookdependsonpoise'
|
598
599
|
Enabled: true
|
599
600
|
VersionAdded: '5.1.0'
|
600
601
|
Include:
|
@@ -602,7 +603,7 @@ Chef/Deprecations/CookbookDependsOnPoise:
|
|
602
603
|
|
603
604
|
Chef/Deprecations/CookbookDependsOnCompatResource:
|
604
605
|
Description: Don't depend on the deprecated compat_resource cookbook made obsolete by Chef Infra Client 12.19+
|
605
|
-
StyleGuide: '
|
606
|
+
StyleGuide: 'chef_deprecations_cookbookdependsoncompatresource'
|
606
607
|
Enabled: true
|
607
608
|
VersionAdded: '5.1.0'
|
608
609
|
Include:
|
@@ -610,7 +611,7 @@ Chef/Deprecations/CookbookDependsOnCompatResource:
|
|
610
611
|
|
611
612
|
Chef/Deprecations/CookbookDependsOnPartialSearch:
|
612
613
|
Description: Don't depend on the deprecated partial_search cookbook made obsolete by Chef Infra Client 13+
|
613
|
-
StyleGuide: '
|
614
|
+
StyleGuide: 'chef_deprecations_cookbookdependsonpartialsearch'
|
614
615
|
Enabled: true
|
615
616
|
VersionAdded: '5.1.0'
|
616
617
|
Include:
|
@@ -618,7 +619,7 @@ Chef/Deprecations/CookbookDependsOnPartialSearch:
|
|
618
619
|
|
619
620
|
Chef/Deprecations/EasyInstallResource:
|
620
621
|
Description: Don't use the deprecated easy_install resource resource removed in Chef Infra Client 13
|
621
|
-
StyleGuide: '
|
622
|
+
StyleGuide: 'chef_deprecations_easyinstallresource'
|
622
623
|
Enabled: true
|
623
624
|
VersionAdded: '5.1.0'
|
624
625
|
Exclude:
|
@@ -628,7 +629,7 @@ Chef/Deprecations/EasyInstallResource:
|
|
628
629
|
|
629
630
|
Chef/Deprecations/ErlCallResource:
|
630
631
|
Description: Don't use the deprecated erl_call resource removed in Chef Infra Client 13
|
631
|
-
StyleGuide: '
|
632
|
+
StyleGuide: 'chef_deprecations_erlcallresource'
|
632
633
|
Enabled: true
|
633
634
|
VersionAdded: '5.1.0'
|
634
635
|
Exclude:
|
@@ -638,7 +639,7 @@ Chef/Deprecations/ErlCallResource:
|
|
638
639
|
|
639
640
|
Chef/Deprecations/RequireRecipe:
|
640
641
|
Description: Use include_recipe instead of the require_recipe method
|
641
|
-
StyleGuide: '
|
642
|
+
StyleGuide: 'chef_deprecations_requirerecipe'
|
642
643
|
Enabled: true
|
643
644
|
VersionAdded: '5.2.0'
|
644
645
|
Exclude:
|
@@ -648,7 +649,7 @@ Chef/Deprecations/RequireRecipe:
|
|
648
649
|
|
649
650
|
Chef/Deprecations/NodeMethodsInsteadofAttributes:
|
650
651
|
Description: Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.
|
651
|
-
StyleGuide: '
|
652
|
+
StyleGuide: 'chef_deprecations_nodemethodsinsteadofattributes'
|
652
653
|
Enabled: true
|
653
654
|
VersionAdded: '5.4.0'
|
654
655
|
Exclude:
|
@@ -657,7 +658,7 @@ Chef/Deprecations/NodeMethodsInsteadofAttributes:
|
|
657
658
|
|
658
659
|
Chef/Deprecations/UsesDeprecatedMixins:
|
659
660
|
Description: Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.
|
660
|
-
StyleGuide: '
|
661
|
+
StyleGuide: 'chef_deprecations_usesdeprecatedmixins'
|
661
662
|
Enabled: true
|
662
663
|
VersionAdded: '5.4.0'
|
663
664
|
Include:
|
@@ -667,7 +668,7 @@ Chef/Deprecations/UsesDeprecatedMixins:
|
|
667
668
|
|
668
669
|
Chef/Deprecations/IncludingXMLRubyRecipe:
|
669
670
|
Description: The xml::ruby recipe installs nokogiri which is included in Chef Infra Client 12 and later.
|
670
|
-
StyleGuide: '
|
671
|
+
StyleGuide: 'chef_deprecations_includingxmlrubyrecipe'
|
671
672
|
Enabled: true
|
672
673
|
VersionAdded: '5.4.0'
|
673
674
|
Exclude:
|
@@ -677,7 +678,7 @@ Chef/Deprecations/IncludingXMLRubyRecipe:
|
|
677
678
|
|
678
679
|
Chef/Deprecations/LegacyYumCookbookRecipes:
|
679
680
|
Description: The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).
|
680
|
-
StyleGuide: '
|
681
|
+
StyleGuide: 'chef_deprecations_legacyyumcookbookrecipes'
|
681
682
|
Enabled: true
|
682
683
|
VersionAdded: '5.4.0'
|
683
684
|
Exclude:
|
@@ -685,7 +686,7 @@ Chef/Deprecations/LegacyYumCookbookRecipes:
|
|
685
686
|
|
686
687
|
Chef/Deprecations/UsesChefRESTHelpers:
|
687
688
|
Description: Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13
|
688
|
-
StyleGuide: '
|
689
|
+
StyleGuide: 'chef_deprecations_useschefresthelpers'
|
689
690
|
Enabled: true
|
690
691
|
VersionAdded: '5.5.0'
|
691
692
|
Exclude:
|
@@ -693,7 +694,7 @@ Chef/Deprecations/UsesChefRESTHelpers:
|
|
693
694
|
|
694
695
|
Chef/Deprecations/ChocolateyPackageUninstallAction:
|
695
696
|
Description: Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
|
696
|
-
StyleGuide: '
|
697
|
+
StyleGuide: 'chef_deprecations_chocolateypackageuninstallaction'
|
697
698
|
Enabled: true
|
698
699
|
VersionAdded: '5.5.0'
|
699
700
|
Exclude:
|
@@ -701,7 +702,7 @@ Chef/Deprecations/ChocolateyPackageUninstallAction:
|
|
701
702
|
|
702
703
|
Chef/Deprecations/LaunchdDeprecatedHashProperty:
|
703
704
|
Description: The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
|
704
|
-
StyleGuide: '
|
705
|
+
StyleGuide: 'chef_deprecations_launchddeprecatedhashproperty'
|
705
706
|
Enabled: true
|
706
707
|
VersionAdded: '5.5.0'
|
707
708
|
Exclude:
|
@@ -709,7 +710,7 @@ Chef/Deprecations/LaunchdDeprecatedHashProperty:
|
|
709
710
|
|
710
711
|
Chef/Deprecations/LocaleDeprecatedLcAllProperty:
|
711
712
|
Description: The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16
|
712
|
-
StyleGuide: '
|
713
|
+
StyleGuide: 'chef_deprecations_localedeprecatedlcallproperty'
|
713
714
|
Enabled: true
|
714
715
|
VersionAdded: '5.5.0'
|
715
716
|
Exclude:
|
@@ -717,7 +718,7 @@ Chef/Deprecations/LocaleDeprecatedLcAllProperty:
|
|
717
718
|
|
718
719
|
Chef/Deprecations/UserDeprecatedSupportsProperty:
|
719
720
|
Description: The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
|
720
|
-
StyleGuide: '
|
721
|
+
StyleGuide: 'chef_deprecations_userdeprecatedsupportsproperty'
|
721
722
|
Enabled: true
|
722
723
|
VersionAdded: '5.5.0'
|
723
724
|
Exclude:
|
@@ -725,7 +726,7 @@ Chef/Deprecations/UserDeprecatedSupportsProperty:
|
|
725
726
|
|
726
727
|
Chef/Deprecations/UseInlineResourcesDefined:
|
727
728
|
Description: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.
|
728
|
-
StyleGuide: '
|
729
|
+
StyleGuide: 'chef_deprecations_useinlineresourcesdefined'
|
729
730
|
Enabled: true
|
730
731
|
VersionAdded: '5.4.0'
|
731
732
|
Include:
|
@@ -735,7 +736,7 @@ Chef/Deprecations/UseInlineResourcesDefined:
|
|
735
736
|
|
736
737
|
Chef/Deprecations/IncludingYumDNFCompatRecipe:
|
737
738
|
Description: Do not include the yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF.
|
738
|
-
StyleGuide: '
|
739
|
+
StyleGuide: 'chef_deprecations_includingyumdnfcompatrecipe'
|
739
740
|
Enabled: true
|
740
741
|
VersionAdded: '5.3.0'
|
741
742
|
Exclude:
|
@@ -743,7 +744,7 @@ Chef/Deprecations/IncludingYumDNFCompatRecipe:
|
|
743
744
|
|
744
745
|
Chef/Deprecations/WindowsTaskChangeAction:
|
745
746
|
Description: The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.
|
746
|
-
StyleGuide: '
|
747
|
+
StyleGuide: 'chef_deprecations_windowstaskchangeaction'
|
747
748
|
Enabled: true
|
748
749
|
VersionAdded: '5.6.0'
|
749
750
|
Exclude:
|
@@ -751,7 +752,7 @@ Chef/Deprecations/WindowsTaskChangeAction:
|
|
751
752
|
|
752
753
|
Chef/Deprecations/ResourceOverridesProvidesMethod:
|
753
754
|
Description: Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later.
|
754
|
-
StyleGuide: '
|
755
|
+
StyleGuide: 'chef_deprecations_resourceoverridesprovidesmethod'
|
755
756
|
Enabled: true
|
756
757
|
VersionAdded: '5.7.0'
|
757
758
|
Include:
|
@@ -761,7 +762,7 @@ Chef/Deprecations/ResourceOverridesProvidesMethod:
|
|
761
762
|
|
762
763
|
Chef/Deprecations/ResourceUsesDslNameMethod:
|
763
764
|
Description: Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.
|
764
|
-
StyleGuide: '
|
765
|
+
StyleGuide: 'chef_deprecations_resourceusesdslnamemethod'
|
765
766
|
Enabled: true
|
766
767
|
VersionAdded: '5.7.0'
|
767
768
|
Include:
|
@@ -771,7 +772,7 @@ Chef/Deprecations/ResourceUsesDslNameMethod:
|
|
771
772
|
|
772
773
|
Chef/Deprecations/ResourceUsesUpdatedMethod:
|
773
774
|
Description: Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later.
|
774
|
-
StyleGuide: '
|
775
|
+
StyleGuide: 'chef_deprecations_resourceusesupdatedmethod'
|
775
776
|
Enabled: false # has a high potential for false positives
|
776
777
|
VersionAdded: '5.7.0'
|
777
778
|
Include:
|
@@ -781,7 +782,7 @@ Chef/Deprecations/ResourceUsesUpdatedMethod:
|
|
781
782
|
|
782
783
|
Chef/Deprecations/NamePropertyWithDefaultValue:
|
783
784
|
Description: A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later.
|
784
|
-
StyleGuide: '
|
785
|
+
StyleGuide: 'chef_deprecations_namepropertywithdefaultvalue'
|
785
786
|
Enabled: true
|
786
787
|
VersionAdded: '5.7.0'
|
787
788
|
Include:
|
@@ -790,7 +791,7 @@ Chef/Deprecations/NamePropertyWithDefaultValue:
|
|
790
791
|
|
791
792
|
Chef/Deprecations/ResourceUsesProviderBaseMethod:
|
792
793
|
Description: Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later.
|
793
|
-
StyleGuide: '
|
794
|
+
StyleGuide: 'chef_deprecations_resourceusesproviderbasemethod'
|
794
795
|
Enabled: true
|
795
796
|
VersionAdded: '5.7.0'
|
796
797
|
Include:
|
@@ -799,7 +800,7 @@ Chef/Deprecations/ResourceUsesProviderBaseMethod:
|
|
799
800
|
|
800
801
|
Chef/Deprecations/ChefSpecCoverageReport:
|
801
802
|
Description: Don't use the deprecated ChefSpec coverage report functionality in your specs.
|
802
|
-
StyleGuide: '
|
803
|
+
StyleGuide: 'chef_deprecations_chefspeccoveragereport'
|
803
804
|
Enabled: true
|
804
805
|
VersionAdded: '5.8.0'
|
805
806
|
Include:
|
@@ -807,7 +808,7 @@ Chef/Deprecations/ChefSpecCoverageReport:
|
|
807
808
|
|
808
809
|
Chef/Deprecations/ChefSpecLegacyRunner:
|
809
810
|
Description: Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.
|
810
|
-
StyleGuide: '
|
811
|
+
StyleGuide: 'chef_deprecations_chefspeclegacyrunner'
|
811
812
|
Enabled: true
|
812
813
|
VersionAdded: '5.8.0'
|
813
814
|
Include:
|
@@ -815,7 +816,7 @@ Chef/Deprecations/ChefSpecLegacyRunner:
|
|
815
816
|
|
816
817
|
Chef/Deprecations/UsesRunCommandHelper:
|
817
818
|
Description: Use 'shell_out!' instead of the legacy 'run_command' helper for shelling out. The run_command helper was removed in Chef Infra Client 13.
|
818
|
-
StyleGuide: '
|
819
|
+
StyleGuide: 'chef_deprecations_usesruncommandhelper'
|
819
820
|
Enabled: true
|
820
821
|
VersionAdded: '5.9.0'
|
821
822
|
Exclude:
|
@@ -825,7 +826,7 @@ Chef/Deprecations/UsesRunCommandHelper:
|
|
825
826
|
|
826
827
|
Chef/Deprecations/ChefHandlerUsesSupports:
|
827
828
|
Description: Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
|
828
|
-
StyleGuide: '
|
829
|
+
StyleGuide: 'chef_deprecations_chefhandlerusessupports'
|
829
830
|
Enabled: true
|
830
831
|
VersionAdded: '5.9.0'
|
831
832
|
Exclude:
|
@@ -833,7 +834,7 @@ Chef/Deprecations/ChefHandlerUsesSupports:
|
|
833
834
|
|
834
835
|
Chef/Deprecations/DeprecatedYumRepositoryProperties:
|
835
836
|
Description: With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.
|
836
|
-
StyleGuide: '
|
837
|
+
StyleGuide: 'chef_deprecations_deprecatedyumrepositoryproperties'
|
837
838
|
Enabled: true
|
838
839
|
VersionAdded: '5.10.0'
|
839
840
|
Exclude:
|
@@ -843,7 +844,7 @@ Chef/Deprecations/DeprecatedYumRepositoryProperties:
|
|
843
844
|
|
844
845
|
Chef/Deprecations/EOLAuditModeUsage:
|
845
846
|
Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more informmation.
|
846
|
-
StyleGuide: '
|
847
|
+
StyleGuide: 'chef_deprecations_eolauditmodeusage'
|
847
848
|
Enabled: true
|
848
849
|
VersionAdded: '5.10.0'
|
849
850
|
Exclude:
|
@@ -853,7 +854,7 @@ Chef/Deprecations/EOLAuditModeUsage:
|
|
853
854
|
|
854
855
|
Chef/Deprecations/ResourceInheritsFromCompatResource:
|
855
856
|
Description: HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
|
856
|
-
StyleGuide: '
|
857
|
+
StyleGuide: 'chef_deprecations_resourceinheritsfromcompatresource'
|
857
858
|
Enabled: true
|
858
859
|
VersionAdded: '5.10.0'
|
859
860
|
Include:
|
@@ -861,7 +862,7 @@ Chef/Deprecations/ResourceInheritsFromCompatResource:
|
|
861
862
|
|
862
863
|
Chef/Deprecations/VerifyPropertyUsesFileExpansion:
|
863
864
|
Description: Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13.
|
864
|
-
StyleGuide: '
|
865
|
+
StyleGuide: 'chef_deprecations_verifypropertyusesfileexpansion'
|
865
866
|
Enabled: true
|
866
867
|
VersionAdded: '5.10.0'
|
867
868
|
Exclude:
|
@@ -871,7 +872,7 @@ Chef/Deprecations/VerifyPropertyUsesFileExpansion:
|
|
871
872
|
|
872
873
|
Chef/Deprecations/PoiseArchiveUsage:
|
873
874
|
Description: The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
|
874
|
-
StyleGuide: '
|
875
|
+
StyleGuide: 'chef_deprecations_poisearchiveusage'
|
875
876
|
Enabled: true
|
876
877
|
VersionAdded: '5.11.0'
|
877
878
|
Exclude:
|
@@ -881,7 +882,7 @@ Chef/Deprecations/PoiseArchiveUsage:
|
|
881
882
|
|
882
883
|
Chef/Deprecations/PartialSearchHelperUsage:
|
883
884
|
Description: Legacy partial_search usage should be updated to use :filter_result in the search helper instead.
|
884
|
-
StyleGuide: '
|
885
|
+
StyleGuide: 'chef_deprecations_partialsearchhelperusage'
|
885
886
|
Enabled: true
|
886
887
|
VersionAdded: '5.11.0'
|
887
888
|
Exclude:
|
@@ -889,7 +890,7 @@ Chef/Deprecations/PartialSearchHelperUsage:
|
|
889
890
|
|
890
891
|
Chef/Deprecations/SearchUsesPositionalParameters:
|
891
892
|
Description: Don't use deprecated positional parameters in cookbook search queries.
|
892
|
-
StyleGuide: '
|
893
|
+
StyleGuide: 'chef_deprecations_searchusespositionalparameters'
|
893
894
|
Enabled: true
|
894
895
|
VersionAdded: '5.11.0'
|
895
896
|
Exclude:
|
@@ -897,7 +898,7 @@ Chef/Deprecations/SearchUsesPositionalParameters:
|
|
897
898
|
|
898
899
|
Chef/Deprecations/PartialSearchClassUsage:
|
899
900
|
Description: Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.
|
900
|
-
StyleGuide: '
|
901
|
+
StyleGuide: 'chef_deprecations_partialsearchclassusage'
|
901
902
|
Enabled: true
|
902
903
|
VersionAdded: '5.11.0'
|
903
904
|
Exclude:
|
@@ -905,7 +906,7 @@ Chef/Deprecations/PartialSearchClassUsage:
|
|
905
906
|
|
906
907
|
Chef/Deprecations/Cheffile:
|
907
908
|
Description: The Libarian-Chef depsolving project is no longer maintained and should not be used for cookbook depsolving. Consider using Policyfiles instead.
|
908
|
-
StyleGuide: '
|
909
|
+
StyleGuide: 'chef_deprecations_cheffile'
|
909
910
|
Enabled: true
|
910
911
|
VersionAdded: '5.12.0'
|
911
912
|
Include:
|
@@ -913,7 +914,7 @@ Chef/Deprecations/Cheffile:
|
|
913
914
|
|
914
915
|
Chef/Deprecations/LegacyNotifySyntax:
|
915
916
|
Description: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
|
916
|
-
StyleGuide: '
|
917
|
+
StyleGuide: 'chef_deprecations_legacynotifysyntax'
|
917
918
|
Enabled: true
|
918
919
|
VersionAdded: '5.13.0'
|
919
920
|
Exclude:
|
@@ -923,7 +924,7 @@ Chef/Deprecations/LegacyNotifySyntax:
|
|
923
924
|
|
924
925
|
Chef/Deprecations/NodeSetWithoutLevel:
|
925
926
|
Description: When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
|
926
|
-
StyleGuide: '
|
927
|
+
StyleGuide: 'chef_deprecations_nodesetwithoutlevel'
|
927
928
|
Enabled: true
|
928
929
|
VersionAdded: '5.13.0'
|
929
930
|
Exclude:
|
@@ -932,7 +933,7 @@ Chef/Deprecations/NodeSetWithoutLevel:
|
|
932
933
|
|
933
934
|
Chef/Deprecations/ChefRewind:
|
934
935
|
Description: Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem
|
935
|
-
StyleGuide: '
|
936
|
+
StyleGuide: 'chef_deprecations_chefrewind'
|
936
937
|
Enabled: true
|
937
938
|
VersionAdded: '5.14.0'
|
938
939
|
Exclude:
|
@@ -941,7 +942,7 @@ Chef/Deprecations/ChefRewind:
|
|
941
942
|
|
942
943
|
Chef/Deprecations/RubyBlockCreateAction:
|
943
944
|
Description: Use the :run action in the ruby_block resource instead of the deprecated :create action
|
944
|
-
StyleGuide: '
|
945
|
+
StyleGuide: 'chef_deprecations_rubyblockcreateaction'
|
945
946
|
Enabled: true
|
946
947
|
VersionAdded: '5.16.0'
|
947
948
|
Exclude:
|
@@ -951,7 +952,7 @@ Chef/Deprecations/RubyBlockCreateAction:
|
|
951
952
|
|
952
953
|
Chef/Deprecations/DeprecatedPlatformMethods:
|
953
954
|
Description: Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources.
|
954
|
-
StyleGuide: '
|
955
|
+
StyleGuide: 'chef_deprecations_deprecatedplatformmethods'
|
955
956
|
Enabled: true
|
956
957
|
VersionAdded: '5.16.0'
|
957
958
|
VersionChanged: '6.17.0'
|
@@ -962,7 +963,7 @@ Chef/Deprecations/DeprecatedPlatformMethods:
|
|
962
963
|
|
963
964
|
Chef/Deprecations/DeprecatedChefSpecPlatform:
|
964
965
|
Description: Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3
|
965
|
-
StyleGuide: '
|
966
|
+
StyleGuide: 'chef_deprecations_deprecatedchefspecplatform'
|
966
967
|
Enabled: true
|
967
968
|
VersionAdded: '5.20.0'
|
968
969
|
Include:
|
@@ -970,7 +971,7 @@ Chef/Deprecations/DeprecatedChefSpecPlatform:
|
|
970
971
|
|
971
972
|
Chef/Deprecations/WindowsFeatureServermanagercmd:
|
972
973
|
Description: The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
|
973
|
-
StyleGuide: '
|
974
|
+
StyleGuide: 'chef_deprecations_windowsfeatureservermanagercmd'
|
974
975
|
Enabled: true
|
975
976
|
VersionAdded: '5.22.0'
|
976
977
|
Exclude:
|
@@ -980,7 +981,7 @@ Chef/Deprecations/WindowsFeatureServermanagercmd:
|
|
980
981
|
|
981
982
|
Chef/Deprecations/DeprecatedWindowsVersionCheck:
|
982
983
|
Description: Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
|
983
|
-
StyleGuide: '
|
984
|
+
StyleGuide: 'chef_deprecations_deprecatedwindowsversioncheck'
|
984
985
|
Enabled: true
|
985
986
|
VersionAdded: '6.0.0'
|
986
987
|
Exclude:
|
@@ -989,7 +990,7 @@ Chef/Deprecations/DeprecatedWindowsVersionCheck:
|
|
989
990
|
|
990
991
|
Chef/Deprecations/ChefWindowsPlatformHelper:
|
991
992
|
Description: Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper.
|
992
|
-
StyleGuide: '
|
993
|
+
StyleGuide: 'chef_deprecations_chefwindowsplatformhelper'
|
993
994
|
Enabled: true
|
994
995
|
VersionAdded: '6.0.0'
|
995
996
|
Exclude:
|
@@ -998,7 +999,7 @@ Chef/Deprecations/ChefWindowsPlatformHelper:
|
|
998
999
|
|
999
1000
|
Chef/Deprecations/LogResourceNotifications:
|
1000
1001
|
Description: In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource instead to aggregate notifications.
|
1001
|
-
StyleGuide: '
|
1002
|
+
StyleGuide: 'chef_deprecations_logresourcenotifications'
|
1002
1003
|
Enabled: true
|
1003
1004
|
VersionAdded: '6.0.0'
|
1004
1005
|
Exclude:
|
@@ -1007,7 +1008,7 @@ Chef/Deprecations/LogResourceNotifications:
|
|
1007
1008
|
|
1008
1009
|
Chef/Deprecations/HWRPWithoutProvides:
|
1009
1010
|
Description: In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
|
1010
|
-
StyleGuide: '
|
1011
|
+
StyleGuide: 'chef_deprecations_resourcewithoutnameorprovides'
|
1011
1012
|
Enabled: true
|
1012
1013
|
VersionAdded: '6.0.0'
|
1013
1014
|
VersionChanged: '6.8.0'
|
@@ -1016,7 +1017,7 @@ Chef/Deprecations/HWRPWithoutProvides:
|
|
1016
1017
|
|
1017
1018
|
Chef/Deprecations/WindowsVersionHelpers:
|
1018
1019
|
Description: Use node['platform_version'] data instead of the Windows::VersionHelper helper from the Windows cookbook.
|
1019
|
-
StyleGuide: '
|
1020
|
+
StyleGuide: 'chef_deprecations_windowsversionhelpers'
|
1020
1021
|
Enabled: true
|
1021
1022
|
VersionAdded: '5.4.0'
|
1022
1023
|
Exclude:
|
@@ -1025,7 +1026,7 @@ Chef/Deprecations/WindowsVersionHelpers:
|
|
1025
1026
|
|
1026
1027
|
Chef/Deprecations/PowershellCookbookHelpers:
|
1027
1028
|
Description: Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 16+ instead of the deprecated PowerShell cookbook helpers.
|
1028
|
-
StyleGuide: '
|
1029
|
+
StyleGuide: 'chef_deprecations_powershellcookbookhelpers'
|
1029
1030
|
Enabled: true
|
1030
1031
|
VersionAdded: '6.1.0'
|
1031
1032
|
Exclude:
|
@@ -1034,7 +1035,7 @@ Chef/Deprecations/PowershellCookbookHelpers:
|
|
1034
1035
|
|
1035
1036
|
Chef/Deprecations/DeprecatedShelloutMethods:
|
1036
1037
|
Description: Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.
|
1037
|
-
StyleGuide: '
|
1038
|
+
StyleGuide: 'chef_deprecations_deprecatedshelloutmethods'
|
1038
1039
|
Enabled: true
|
1039
1040
|
VersionAdded: '6.3.0'
|
1040
1041
|
Exclude:
|
@@ -1044,7 +1045,7 @@ Chef/Deprecations/DeprecatedShelloutMethods:
|
|
1044
1045
|
|
1045
1046
|
Chef/Deprecations/Ruby27KeywordArgumentWarnings:
|
1046
1047
|
Description: Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
|
1047
|
-
StyleGuide: '
|
1048
|
+
StyleGuide: 'chef_deprecations_ruby27keywordargumentwarnings'
|
1048
1049
|
Enabled: true
|
1049
1050
|
VersionAdded: '6.5.0'
|
1050
1051
|
Exclude:
|
@@ -1053,7 +1054,7 @@ Chef/Deprecations/Ruby27KeywordArgumentWarnings:
|
|
1053
1054
|
|
1054
1055
|
Chef/Deprecations/ResourceUsesOnlyResourceName:
|
1055
1056
|
Description: Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Use `provides` to change the name of the resource instead and omit `resource_name` entirely if it matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
|
1056
|
-
StyleGuide: '
|
1057
|
+
StyleGuide: 'chef_deprecations_resourceusesonlyresourcename'
|
1057
1058
|
Enabled: true
|
1058
1059
|
VersionAdded: '6.7.0'
|
1059
1060
|
Include:
|
@@ -1062,7 +1063,7 @@ Chef/Deprecations/ResourceUsesOnlyResourceName:
|
|
1062
1063
|
|
1063
1064
|
Chef/Deprecations/ChefDKGenerators:
|
1064
1065
|
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.
|
1065
|
-
StyleGuide: '
|
1066
|
+
StyleGuide: 'chef_deprecations_chefdkgenerators'
|
1066
1067
|
Enabled: true
|
1067
1068
|
VersionAdded: '6.12.0'
|
1068
1069
|
Exclude:
|
@@ -1071,7 +1072,7 @@ Chef/Deprecations/ChefDKGenerators:
|
|
1071
1072
|
|
1072
1073
|
Chef/Deprecations/ChefHandlerRecipe:
|
1073
1074
|
Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
|
1074
|
-
StyleGuide: '
|
1075
|
+
StyleGuide: 'chef_deprecations_chefhandlerrecipe'
|
1075
1076
|
Enabled: true
|
1076
1077
|
VersionAdded: '6.12.0'
|
1077
1078
|
Exclude:
|
@@ -1080,7 +1081,7 @@ Chef/Deprecations/ChefHandlerRecipe:
|
|
1080
1081
|
|
1081
1082
|
Chef/Deprecations/UseAutomaticResourceName:
|
1082
1083
|
Description: The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
|
1083
|
-
StyleGuide: '
|
1084
|
+
StyleGuide: 'chef_deprecations_useautomaticresourcename'
|
1084
1085
|
Enabled: true
|
1085
1086
|
VersionAdded: '6.12.0'
|
1086
1087
|
Include:
|
@@ -1089,7 +1090,7 @@ Chef/Deprecations/UseAutomaticResourceName:
|
|
1089
1090
|
|
1090
1091
|
Chef/Deprecations/MacosUserdefaultsGlobalProperty:
|
1091
1092
|
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.
|
1092
|
-
StyleGuide: '
|
1093
|
+
StyleGuide: 'chef_deprecations_macosuserdefaultsglobalproperty'
|
1093
1094
|
Enabled: true
|
1094
1095
|
VersionAdded: '6.14.0'
|
1095
1096
|
Exclude:
|
@@ -1098,7 +1099,7 @@ Chef/Deprecations/MacosUserdefaultsGlobalProperty:
|
|
1098
1099
|
|
1099
1100
|
Chef/Deprecations/CookbooksDependsOnSelf:
|
1100
1101
|
Description: A cookbook cannot depend on itself in Chef Infra Client 13 or later.
|
1101
|
-
StyleGuide: '
|
1102
|
+
StyleGuide: 'chef_deprecations_cookbooksdependonself'
|
1102
1103
|
Enabled: true
|
1103
1104
|
VersionAdded: '5.2.0'
|
1104
1105
|
VersionChanged: '6.16.0'
|
@@ -1107,7 +1108,7 @@ Chef/Deprecations/CookbooksDependsOnSelf:
|
|
1107
1108
|
|
1108
1109
|
Chef/Deprecations/ChefShellout:
|
1109
1110
|
Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
|
1110
|
-
StyleGuide: '
|
1111
|
+
StyleGuide: 'chef_deprecations_chefshellout'
|
1111
1112
|
Enabled: true
|
1112
1113
|
VersionAdded: '6.17.0'
|
1113
1114
|
Exclude:
|
@@ -1117,7 +1118,7 @@ Chef/Deprecations/ChefShellout:
|
|
1117
1118
|
|
1118
1119
|
Chef/Deprecations/ExecutePathProperty:
|
1119
1120
|
Description: In Chef Infra Client 13 and later you must set path env vars in `execute` resources using the `environment` property not the legacy `path` property.
|
1120
|
-
StyleGuide: '
|
1121
|
+
StyleGuide: 'chef_deprecations_executepathproperty'
|
1121
1122
|
Enabled: true
|
1122
1123
|
VersionAdded: '6.17.0'
|
1123
1124
|
Exclude:
|
@@ -1127,7 +1128,7 @@ Chef/Deprecations/ExecutePathProperty:
|
|
1127
1128
|
|
1128
1129
|
Chef/Deprecations/ExecuteRelativeCreatesWithoutCwd:
|
1129
1130
|
Description: In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
|
1130
|
-
StyleGuide: '
|
1131
|
+
StyleGuide: 'chef_deprecations_executerelativecreateswithoutcwd'
|
1131
1132
|
Enabled: true
|
1132
1133
|
VersionAdded: '6.17.0'
|
1133
1134
|
Exclude:
|
@@ -1137,7 +1138,7 @@ Chef/Deprecations/ExecuteRelativeCreatesWithoutCwd:
|
|
1137
1138
|
|
1138
1139
|
Chef/Deprecations/WindowsPackageInstallerTypeString:
|
1139
1140
|
Description: In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
|
1140
|
-
StyleGuide: '
|
1141
|
+
StyleGuide: 'chef_deprecations_windowspackageinstallertypestring'
|
1141
1142
|
Enabled: true
|
1142
1143
|
VersionAdded: '6.17.0'
|
1143
1144
|
Exclude:
|
@@ -1147,13 +1148,13 @@ Chef/Deprecations/WindowsPackageInstallerTypeString:
|
|
1147
1148
|
|
1148
1149
|
Chef/Deprecations/UseYamlDump:
|
1149
1150
|
Description: Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library.
|
1150
|
-
StyleGuide: '
|
1151
|
+
StyleGuide: 'chef_deprecations_useyamldump'
|
1151
1152
|
Enabled: true
|
1152
1153
|
VersionAdded: '6.21.0'
|
1153
1154
|
|
1154
1155
|
Chef/Deprecations/LibrarianChefSpec:
|
1155
1156
|
Description: The Librarian-Chef depsolving project is no longer maintained and ChefSpec should not use Librarian-Chef for cookbook depsolving. Consider using Policyfiles instead.
|
1156
|
-
StyleGuide: '
|
1157
|
+
StyleGuide: 'chef_deprecations_librarianchefspec'
|
1157
1158
|
Enabled: true
|
1158
1159
|
VersionAdded: '7.1.0'
|
1159
1160
|
Include:
|
@@ -1161,7 +1162,7 @@ Chef/Deprecations/LibrarianChefSpec:
|
|
1161
1162
|
|
1162
1163
|
Chef/Deprecations/FoodcriticTesting:
|
1163
1164
|
Description: The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks
|
1164
|
-
StyleGuide: '
|
1165
|
+
StyleGuide: 'chef_deprecations_foodcritictesting'
|
1165
1166
|
Enabled: true
|
1166
1167
|
VersionAdded: '7.1.0'
|
1167
1168
|
Include:
|
@@ -1170,7 +1171,7 @@ Chef/Deprecations/FoodcriticTesting:
|
|
1170
1171
|
|
1171
1172
|
Chef/Deprecations/DeprecatedYumRepositoryActions:
|
1172
1173
|
Description: With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several actions in the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
|
1173
|
-
StyleGuide: '
|
1174
|
+
StyleGuide: 'chef_deprecations_deprecatedyumrepositoryactions'
|
1174
1175
|
Enabled: true
|
1175
1176
|
VersionAdded: '7.3.0'
|
1176
1177
|
Exclude:
|
@@ -1181,7 +1182,7 @@ Chef/Deprecations/DeprecatedYumRepositoryActions:
|
|
1181
1182
|
|
1182
1183
|
Chef/Deprecations/ChefSugarHelpers:
|
1183
1184
|
Description: Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
|
1184
|
-
StyleGuide: '
|
1185
|
+
StyleGuide: 'chef_deprecations_chefsugarhelpers'
|
1185
1186
|
Enabled: true
|
1186
1187
|
VersionAdded: '7.3.0'
|
1187
1188
|
Exclude:
|
@@ -1194,11 +1195,11 @@ Chef/Deprecations/ChefSugarHelpers:
|
|
1194
1195
|
###############################
|
1195
1196
|
|
1196
1197
|
Chef/Modernize:
|
1197
|
-
StyleGuideBaseURL: https://
|
1198
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
1198
1199
|
|
1199
1200
|
Chef/Modernize/LegacyBerksfileSource:
|
1200
1201
|
Description: Do not use legacy Berksfile community sources. Use Chef Supermarket instead.
|
1201
|
-
StyleGuide: '
|
1202
|
+
StyleGuide: 'chef_modernize_legacyberksfilesource'
|
1202
1203
|
Enabled: true
|
1203
1204
|
VersionAdded: '5.1.0'
|
1204
1205
|
Include:
|
@@ -1206,7 +1207,7 @@ Chef/Modernize/LegacyBerksfileSource:
|
|
1206
1207
|
|
1207
1208
|
Chef/Modernize/WhyRunSupportedTrue:
|
1208
1209
|
Description: whyrun_supported? no longer needs to be set to true as it is the default in Chef 13+
|
1209
|
-
StyleGuide: '
|
1210
|
+
StyleGuide: 'chef_modernize_whyrunsupportedtrue'
|
1210
1211
|
Enabled: true
|
1211
1212
|
VersionAdded: '5.1.0'
|
1212
1213
|
Include:
|
@@ -1216,7 +1217,7 @@ Chef/Modernize/WhyRunSupportedTrue:
|
|
1216
1217
|
|
1217
1218
|
Chef/Modernize/UnnecessaryDependsChef14:
|
1218
1219
|
Description: Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
|
1219
|
-
StyleGuide: '
|
1220
|
+
StyleGuide: 'chef_modernize_unnecessarydependschef14'
|
1220
1221
|
Enabled: true
|
1221
1222
|
VersionAdded: '5.1.0'
|
1222
1223
|
Include:
|
@@ -1224,7 +1225,7 @@ Chef/Modernize/UnnecessaryDependsChef14:
|
|
1224
1225
|
|
1225
1226
|
Chef/Modernize/RespondToInMetadata:
|
1226
1227
|
Description: It is no longer necessary to use respond_to? in metadata.rb in Chef Infra Client 12.15 and later
|
1227
|
-
StyleGuide: '
|
1228
|
+
StyleGuide: 'chef_modernize_respondtoinmetadata'
|
1228
1229
|
Enabled: true
|
1229
1230
|
VersionAdded: '5.2.0'
|
1230
1231
|
Include:
|
@@ -1232,7 +1233,7 @@ Chef/Modernize/RespondToInMetadata:
|
|
1232
1233
|
|
1233
1234
|
Chef/Modernize/RespondToResourceName:
|
1234
1235
|
Description: respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+
|
1235
|
-
StyleGuide: '
|
1236
|
+
StyleGuide: 'chef_modernize_respondtoresourcename'
|
1236
1237
|
Enabled: true
|
1237
1238
|
VersionAdded: '5.2.0'
|
1238
1239
|
Include:
|
@@ -1241,7 +1242,7 @@ Chef/Modernize/RespondToResourceName:
|
|
1241
1242
|
|
1242
1243
|
Chef/Modernize/RespondToProvides:
|
1243
1244
|
Description: respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+
|
1244
|
-
StyleGuide: '
|
1245
|
+
StyleGuide: 'chef_modernize_respondtoprovides'
|
1245
1246
|
Enabled: true
|
1246
1247
|
VersionAdded: '5.2.0'
|
1247
1248
|
Include:
|
@@ -1251,7 +1252,7 @@ Chef/Modernize/RespondToProvides:
|
|
1251
1252
|
|
1252
1253
|
Chef/Modernize/SetOrReturnInResources:
|
1253
1254
|
Description: Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality.
|
1254
|
-
StyleGuide: '
|
1255
|
+
StyleGuide: 'chef_modernize_setorreturninresources'
|
1255
1256
|
Enabled: true
|
1256
1257
|
VersionAdded: '5.2.0'
|
1257
1258
|
Include:
|
@@ -1260,7 +1261,7 @@ Chef/Modernize/SetOrReturnInResources:
|
|
1260
1261
|
|
1261
1262
|
Chef/Modernize/CustomResourceWithAttributes:
|
1262
1263
|
Description: Custom Resources should contain properties not attributes.
|
1263
|
-
StyleGuide: '
|
1264
|
+
StyleGuide: 'chef_modernize_customresourcewithattributes'
|
1264
1265
|
Enabled: true
|
1265
1266
|
VersionAdded: '5.2.0'
|
1266
1267
|
Include:
|
@@ -1268,7 +1269,7 @@ Chef/Modernize/CustomResourceWithAttributes:
|
|
1268
1269
|
|
1269
1270
|
Chef/Modernize/IncludingAptDefaultRecipe:
|
1270
1271
|
Description: Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.
|
1271
|
-
StyleGuide: '
|
1272
|
+
StyleGuide: 'chef_modernize_includingaptdefaultrecipe'
|
1272
1273
|
Enabled: true
|
1273
1274
|
VersionAdded: '5.3.0'
|
1274
1275
|
Exclude:
|
@@ -1276,7 +1277,7 @@ Chef/Modernize/IncludingAptDefaultRecipe:
|
|
1276
1277
|
|
1277
1278
|
Chef/Modernize/IncludingWindowsDefaultRecipe:
|
1278
1279
|
Description: Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client
|
1279
|
-
StyleGuide: '
|
1280
|
+
StyleGuide: 'chef_modernize_includingwindowsdefaultrecipe'
|
1280
1281
|
Enabled: true
|
1281
1282
|
VersionAdded: '5.3.0'
|
1282
1283
|
Exclude:
|
@@ -1284,7 +1285,7 @@ Chef/Modernize/IncludingWindowsDefaultRecipe:
|
|
1284
1285
|
|
1285
1286
|
Chef/Modernize/DefinesChefSpecMatchers:
|
1286
1287
|
Description: ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook
|
1287
|
-
StyleGuide: '
|
1288
|
+
StyleGuide: 'chef_modernize_defineschefspecmatchers'
|
1288
1289
|
Enabled: true
|
1289
1290
|
VersionAdded: '5.3.0'
|
1290
1291
|
Include:
|
@@ -1292,7 +1293,7 @@ Chef/Modernize/DefinesChefSpecMatchers:
|
|
1292
1293
|
|
1293
1294
|
Chef/Modernize/ExecuteAptUpdate:
|
1294
1295
|
Description: Use the apt_update resource instead of the execute resource to run an apt-get update package cache update
|
1295
|
-
StyleGuide: '
|
1296
|
+
StyleGuide: 'chef_modernize_executeaptupdate'
|
1296
1297
|
Enabled: true
|
1297
1298
|
VersionAdded: '5.3.0'
|
1298
1299
|
Exclude:
|
@@ -1300,7 +1301,7 @@ Chef/Modernize/ExecuteAptUpdate:
|
|
1300
1301
|
|
1301
1302
|
Chef/Modernize/MinitestHandlerUsage:
|
1302
1303
|
Description: Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
|
1303
|
-
StyleGuide: '
|
1304
|
+
StyleGuide: 'chef_modernize_minitesthandlerusage'
|
1304
1305
|
Enabled: true
|
1305
1306
|
VersionAdded: '5.4.0'
|
1306
1307
|
Include:
|
@@ -1308,7 +1309,7 @@ Chef/Modernize/MinitestHandlerUsage:
|
|
1308
1309
|
|
1309
1310
|
Chef/Modernize/IncludingMixinShelloutInResources:
|
1310
1311
|
Description: There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
|
1311
|
-
StyleGuide: '
|
1312
|
+
StyleGuide: 'chef_modernize_includingmixinshelloutinresources'
|
1312
1313
|
Enabled: true
|
1313
1314
|
VersionAdded: '5.4.0'
|
1314
1315
|
Include:
|
@@ -1318,7 +1319,7 @@ Chef/Modernize/IncludingMixinShelloutInResources:
|
|
1318
1319
|
|
1319
1320
|
Chef/Modernize/UseBuildEssentialResource:
|
1320
1321
|
Description: Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+
|
1321
|
-
StyleGuide: '
|
1322
|
+
StyleGuide: 'chef_modernize_usebuildessentialresource'
|
1322
1323
|
Enabled: true
|
1323
1324
|
VersionAdded: '5.1.0'
|
1324
1325
|
Exclude:
|
@@ -1326,7 +1327,7 @@ Chef/Modernize/UseBuildEssentialResource:
|
|
1326
1327
|
|
1327
1328
|
Chef/Modernize/WindowsZipfileUsage:
|
1328
1329
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
|
1329
|
-
StyleGuide: '
|
1330
|
+
StyleGuide: 'chef_modernize_windowszipfileusage'
|
1330
1331
|
Enabled: true
|
1331
1332
|
VersionAdded: '5.4.0'
|
1332
1333
|
Exclude:
|
@@ -1334,7 +1335,7 @@ Chef/Modernize/WindowsZipfileUsage:
|
|
1334
1335
|
|
1335
1336
|
Chef/Modernize/SevenZipArchiveResource:
|
1336
1337
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
|
1337
|
-
StyleGuide: '
|
1338
|
+
StyleGuide: 'chef_modernize_sevenziparchiveresource'
|
1338
1339
|
Enabled: true
|
1339
1340
|
VersionAdded: '5.5.0'
|
1340
1341
|
Exclude:
|
@@ -1342,7 +1343,7 @@ Chef/Modernize/SevenZipArchiveResource:
|
|
1342
1343
|
|
1343
1344
|
Chef/Modernize/LibarchiveFileResource:
|
1344
1345
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource
|
1345
|
-
StyleGuide: '
|
1346
|
+
StyleGuide: 'chef_modernize_libarchivefileresource'
|
1346
1347
|
Enabled: true
|
1347
1348
|
VersionAdded: '5.5.0'
|
1348
1349
|
Exclude:
|
@@ -1350,7 +1351,7 @@ Chef/Modernize/LibarchiveFileResource:
|
|
1350
1351
|
|
1351
1352
|
Chef/Modernize/PowershellScriptExpandArchive:
|
1352
1353
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource
|
1353
|
-
StyleGuide: '
|
1354
|
+
StyleGuide: 'chef_modernize_powershellscriptexpandarchive'
|
1354
1355
|
Enabled: true
|
1355
1356
|
VersionAdded: '5.5.0'
|
1356
1357
|
Exclude:
|
@@ -1358,7 +1359,7 @@ Chef/Modernize/PowershellScriptExpandArchive:
|
|
1358
1359
|
|
1359
1360
|
Chef/Modernize/PowershellInstallPackage:
|
1360
1361
|
Description: Use the package resource built into Chef Infra Client instead of using Install-Package in a powershell_script resource
|
1361
|
-
StyleGuide: '
|
1362
|
+
StyleGuide: 'chef_modernize_powershellinstallpackage'
|
1362
1363
|
Enabled: true
|
1363
1364
|
VersionAdded: '5.5.0'
|
1364
1365
|
Exclude:
|
@@ -1366,7 +1367,7 @@ Chef/Modernize/PowershellInstallPackage:
|
|
1366
1367
|
|
1367
1368
|
Chef/Modernize/PowershellInstallWindowsFeature:
|
1368
1369
|
Description: Use the windows_feature resource built into Chef Infra Client 13+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource
|
1369
|
-
StyleGuide: '
|
1370
|
+
StyleGuide: 'chef_modernize_powershellinstallwindowsfeature'
|
1370
1371
|
Enabled: true
|
1371
1372
|
VersionAdded: '5.5.0'
|
1372
1373
|
Exclude:
|
@@ -1374,7 +1375,7 @@ Chef/Modernize/PowershellInstallWindowsFeature:
|
|
1374
1375
|
|
1375
1376
|
Chef/Modernize/ShellOutToChocolatey:
|
1376
1377
|
Description: Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
|
1377
|
-
StyleGuide: '
|
1378
|
+
StyleGuide: 'chef_modernize_shellouttochocolatey'
|
1378
1379
|
Enabled: true
|
1379
1380
|
VersionAdded: '5.5.0'
|
1380
1381
|
Exclude:
|
@@ -1382,7 +1383,7 @@ Chef/Modernize/ShellOutToChocolatey:
|
|
1382
1383
|
|
1383
1384
|
Chef/Modernize/CronManageResource:
|
1384
1385
|
Description: The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.
|
1385
|
-
StyleGuide: '
|
1386
|
+
StyleGuide: 'chef_modernize_cronmanageresource'
|
1386
1387
|
Enabled: true
|
1387
1388
|
VersionAdded: '5.6.0'
|
1388
1389
|
Exclude:
|
@@ -1390,7 +1391,7 @@ Chef/Modernize/CronManageResource:
|
|
1390
1391
|
|
1391
1392
|
Chef/Modernize/UsesZypperRepo:
|
1392
1393
|
Description: The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.
|
1393
|
-
StyleGuide: '
|
1394
|
+
StyleGuide: 'chef_modernize_useszypperrepo'
|
1394
1395
|
Enabled: true
|
1395
1396
|
VersionAdded: '5.6.0'
|
1396
1397
|
Exclude:
|
@@ -1398,7 +1399,7 @@ Chef/Modernize/UsesZypperRepo:
|
|
1398
1399
|
|
1399
1400
|
Chef/Modernize/DependsOnZypperCookbook:
|
1400
1401
|
Description: Don't include the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+
|
1401
|
-
StyleGuide: '
|
1402
|
+
StyleGuide: 'chef_modernize_dependsonzyppercookbook'
|
1402
1403
|
Enabled: true
|
1403
1404
|
VersionAdded: '5.6.0'
|
1404
1405
|
Exclude:
|
@@ -1406,7 +1407,7 @@ Chef/Modernize/DependsOnZypperCookbook:
|
|
1406
1407
|
|
1407
1408
|
Chef/Modernize/ExecuteTzUtil:
|
1408
1409
|
Description: Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil
|
1409
|
-
StyleGuide: '
|
1410
|
+
StyleGuide: 'chef_modernize_executetzutil'
|
1410
1411
|
Enabled: true
|
1411
1412
|
VersionAdded: '5.6.0'
|
1412
1413
|
Exclude:
|
@@ -1414,7 +1415,7 @@ Chef/Modernize/ExecuteTzUtil:
|
|
1414
1415
|
|
1415
1416
|
Chef/Modernize/OpensslRsaKeyResource:
|
1416
1417
|
Description: The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.
|
1417
|
-
StyleGuide: '
|
1418
|
+
StyleGuide: 'chef_modernize_opensslrsakeyresource'
|
1418
1419
|
Enabled: true
|
1419
1420
|
VersionAdded: '5.6.0'
|
1420
1421
|
Exclude:
|
@@ -1422,7 +1423,7 @@ Chef/Modernize/OpensslRsaKeyResource:
|
|
1422
1423
|
|
1423
1424
|
Chef/Modernize/OpensslX509Resource:
|
1424
1425
|
Description: The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.
|
1425
|
-
StyleGuide: '
|
1426
|
+
StyleGuide: 'chef_modernize_opensslx509resource'
|
1426
1427
|
Enabled: true
|
1427
1428
|
VersionAdded: '5.6.0'
|
1428
1429
|
Exclude:
|
@@ -1430,7 +1431,7 @@ Chef/Modernize/OpensslX509Resource:
|
|
1430
1431
|
|
1431
1432
|
Chef/Modernize/OsxConfigProfileResource:
|
1432
1433
|
Description: The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.
|
1433
|
-
StyleGuide: '
|
1434
|
+
StyleGuide: 'chef_modernize_osxconfigprofileresource'
|
1434
1435
|
Enabled: true
|
1435
1436
|
VersionAdded: '5.6.0'
|
1436
1437
|
Exclude:
|
@@ -1438,7 +1439,7 @@ Chef/Modernize/OsxConfigProfileResource:
|
|
1438
1439
|
|
1439
1440
|
Chef/Modernize/SysctlParamResource:
|
1440
1441
|
Description: The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
|
1441
|
-
StyleGuide: '
|
1442
|
+
StyleGuide: 'chef_modernize_sysctlparamresource'
|
1442
1443
|
Enabled: true
|
1443
1444
|
VersionAdded: '5.6.0'
|
1444
1445
|
Exclude:
|
@@ -1446,7 +1447,7 @@ Chef/Modernize/SysctlParamResource:
|
|
1446
1447
|
|
1447
1448
|
Chef/Modernize/MacOsXUserdefaults:
|
1448
1449
|
Description: The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
|
1449
|
-
StyleGuide: '
|
1450
|
+
StyleGuide: 'chef_modernize_macosxuserdefaults'
|
1450
1451
|
Enabled: true
|
1451
1452
|
VersionAdded: '5.6.0'
|
1452
1453
|
Exclude:
|
@@ -1454,7 +1455,7 @@ Chef/Modernize/MacOsXUserdefaults:
|
|
1454
1455
|
|
1455
1456
|
Chef/Modernize/PowerShellGuardInterpreter:
|
1456
1457
|
Description: PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.
|
1457
|
-
StyleGuide: '
|
1458
|
+
StyleGuide: 'chef_modernize_powershellguardinterpreter'
|
1458
1459
|
Enabled: true
|
1459
1460
|
VersionAdded: '5.9.0'
|
1460
1461
|
Exclude:
|
@@ -1462,7 +1463,7 @@ Chef/Modernize/PowerShellGuardInterpreter:
|
|
1462
1463
|
|
1463
1464
|
Chef/Modernize/DefaultActionFromInitialize:
|
1464
1465
|
Description: The default actions can now be specified using the `default_action` helper instead of using the @action variable in the resource provider initialize method.
|
1465
|
-
StyleGuide: '
|
1466
|
+
StyleGuide: 'chef_modernize_defaultactionfrominitialize'
|
1466
1467
|
Enabled: true
|
1467
1468
|
VersionAdded: '5.10.0'
|
1468
1469
|
Include:
|
@@ -1472,7 +1473,7 @@ Chef/Modernize/DefaultActionFromInitialize:
|
|
1472
1473
|
|
1473
1474
|
Chef/Modernize/ResourceNameFromInitialize:
|
1474
1475
|
Description: The name of a resource can be set with the "resource_name" helper instead of using the initialize method.
|
1475
|
-
StyleGuide: '
|
1476
|
+
StyleGuide: 'chef_modernize_resourcenamefrominitialize'
|
1476
1477
|
Enabled: true
|
1477
1478
|
VersionAdded: '5.10.0'
|
1478
1479
|
Include:
|
@@ -1482,7 +1483,7 @@ Chef/Modernize/ResourceNameFromInitialize:
|
|
1482
1483
|
|
1483
1484
|
Chef/Modernize/Definitions:
|
1484
1485
|
Description: Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.
|
1485
|
-
StyleGuide: '
|
1486
|
+
StyleGuide: 'chef_modernize_definitions'
|
1486
1487
|
Enabled: true
|
1487
1488
|
VersionAdded: '5.11.0'
|
1488
1489
|
Include:
|
@@ -1490,7 +1491,7 @@ Chef/Modernize/Definitions:
|
|
1490
1491
|
|
1491
1492
|
Chef/Modernize/IfProvidesDefaultAction:
|
1492
1493
|
Description: if defined?(default_action) is no longer necessary in Chef Infra resources as default_action shipped in Chef Infra Client 10.8.
|
1493
|
-
StyleGuide: '
|
1494
|
+
StyleGuide: 'chef_modernize_ifprovidesdefaultaction'
|
1494
1495
|
Enabled: true
|
1495
1496
|
VersionAdded: '5.12.0'
|
1496
1497
|
Include:
|
@@ -1499,13 +1500,13 @@ Chef/Modernize/IfProvidesDefaultAction:
|
|
1499
1500
|
|
1500
1501
|
Chef/Modernize/ZipfileResource:
|
1501
1502
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
|
1502
|
-
StyleGuide: '
|
1503
|
+
StyleGuide: 'chef_modernize_zipfileresource'
|
1503
1504
|
Enabled: true
|
1504
1505
|
VersionAdded: '5.12.0'
|
1505
1506
|
|
1506
1507
|
Chef/Modernize/UnnecessaryMixlibShelloutRequire:
|
1507
1508
|
Description: Chef Infra Client 12.4 and later include mixlib/shellout automatically in resources and providers.
|
1508
|
-
StyleGuide: '
|
1509
|
+
StyleGuide: 'chef_modernize_unnecessarymixlibshelloutrequire'
|
1509
1510
|
Enabled: true
|
1510
1511
|
VersionAdded: '5.12.0'
|
1511
1512
|
Include:
|
@@ -1514,7 +1515,7 @@ Chef/Modernize/UnnecessaryMixlibShelloutRequire:
|
|
1514
1515
|
|
1515
1516
|
Chef/Modernize/EmptyResourceInitializeMethod:
|
1516
1517
|
Description: There is no need for an empty initialize method in a resource
|
1517
|
-
StyleGuide: '
|
1518
|
+
StyleGuide: 'chef_modernize_emptyresourceinitializemethod'
|
1518
1519
|
Enabled: true
|
1519
1520
|
VersionAdded: '5.13.0'
|
1520
1521
|
Include:
|
@@ -1523,7 +1524,7 @@ Chef/Modernize/EmptyResourceInitializeMethod:
|
|
1523
1524
|
|
1524
1525
|
Chef/Modernize/ChefGemNokogiri:
|
1525
1526
|
Description: The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.
|
1526
|
-
StyleGuide: '
|
1527
|
+
StyleGuide: 'chef_modernize_chefgemnokogiri'
|
1527
1528
|
Enabled: true
|
1528
1529
|
VersionAdded: '5.14.0'
|
1529
1530
|
Exclude:
|
@@ -1532,7 +1533,7 @@ Chef/Modernize/ChefGemNokogiri:
|
|
1532
1533
|
|
1533
1534
|
Chef/Modernize/PropertyWithNameAttribute:
|
1534
1535
|
Description: Resource property sets name_attribute not name_property
|
1535
|
-
StyleGuide: '
|
1536
|
+
StyleGuide: 'chef_modernize_propertywithnameattribute'
|
1536
1537
|
Enabled: true
|
1537
1538
|
VersionAdded: '5.1.0'
|
1538
1539
|
VersionChanged: '5.15.0'
|
@@ -1542,7 +1543,7 @@ Chef/Modernize/PropertyWithNameAttribute:
|
|
1542
1543
|
|
1543
1544
|
Chef/Modernize/IncludingOhaiDefaultRecipe:
|
1544
1545
|
Description: Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely.
|
1545
|
-
StyleGuide: '
|
1546
|
+
StyleGuide: 'chef_modernize_includingohaidefaultrecipe'
|
1546
1547
|
Enabled: true
|
1547
1548
|
VersionAdded: '5.4.0'
|
1548
1549
|
VersionChanged: '5.15.0'
|
@@ -1552,7 +1553,7 @@ Chef/Modernize/IncludingOhaiDefaultRecipe:
|
|
1552
1553
|
|
1553
1554
|
Chef/Modernize/AllowedActionsFromInitialize:
|
1554
1555
|
Description: The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.
|
1555
|
-
StyleGuide: '
|
1556
|
+
StyleGuide: 'chef_modernize_allowedactionsfrominitialize'
|
1556
1557
|
Enabled: true
|
1557
1558
|
VersionAdded: '5.15.0'
|
1558
1559
|
Include:
|
@@ -1561,7 +1562,7 @@ Chef/Modernize/AllowedActionsFromInitialize:
|
|
1561
1562
|
|
1562
1563
|
Chef/Modernize/FoodcriticComments:
|
1563
1564
|
Description: Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
|
1564
|
-
StyleGuide: '
|
1565
|
+
StyleGuide: 'chef_modernize_foodcriticcomments'
|
1565
1566
|
Enabled: true
|
1566
1567
|
VersionAdded: '5.16.0'
|
1567
1568
|
Exclude:
|
@@ -1569,7 +1570,7 @@ Chef/Modernize/FoodcriticComments:
|
|
1569
1570
|
|
1570
1571
|
Chef/Modernize/ExecuteScExe:
|
1571
1572
|
Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource
|
1572
|
-
StyleGuide: '
|
1573
|
+
StyleGuide: 'chef_modernize_executescexe'
|
1573
1574
|
Enabled: true
|
1574
1575
|
VersionAdded: '5.16.0'
|
1575
1576
|
Exclude:
|
@@ -1579,7 +1580,7 @@ Chef/Modernize/ExecuteScExe:
|
|
1579
1580
|
|
1580
1581
|
Chef/Modernize/WindowsScResource:
|
1581
1582
|
Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.
|
1582
|
-
StyleGuide: '
|
1583
|
+
StyleGuide: 'chef_modernize_windowsscresource'
|
1583
1584
|
Enabled: true
|
1584
1585
|
VersionAdded: '5.16.0'
|
1585
1586
|
Exclude:
|
@@ -1589,7 +1590,7 @@ Chef/Modernize/WindowsScResource:
|
|
1589
1590
|
|
1590
1591
|
Chef/Modernize/ExecuteSleep:
|
1591
1592
|
Description: Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
|
1592
|
-
StyleGuide: '
|
1593
|
+
StyleGuide: 'chef_modernize_executesleep'
|
1593
1594
|
Enabled: true
|
1594
1595
|
VersionAdded: '5.16.0'
|
1595
1596
|
Exclude:
|
@@ -1599,7 +1600,7 @@ Chef/Modernize/ExecuteSleep:
|
|
1599
1600
|
|
1600
1601
|
Chef/Modernize/DslIncludeInResource:
|
1601
1602
|
Description: 'There is no need to include Chef::DSL::Recipe or Chef::DSL::IncludeRecipe classes in resources or providers as this is done automatically.'
|
1602
|
-
StyleGuide: '
|
1603
|
+
StyleGuide: 'chef_modernize_dslincludeinresource'
|
1603
1604
|
Enabled: true
|
1604
1605
|
VersionAdded: '5.17.0'
|
1605
1606
|
Include:
|
@@ -1608,7 +1609,7 @@ Chef/Modernize/DslIncludeInResource:
|
|
1608
1609
|
|
1609
1610
|
Chef/Modernize/ResourceForcingCompileTime:
|
1610
1611
|
Description: The hostname, build_essential, chef_gem, and ohai_hint resources include 'compile_time' properties, which should be used to force the resources to run at compile time by setting `compile_time true`.
|
1611
|
-
StyleGuide: '
|
1612
|
+
StyleGuide: 'chef_modernize_resourceforcingcompiletime'
|
1612
1613
|
Enabled: true
|
1613
1614
|
VersionAdded: '5.18.0'
|
1614
1615
|
Exclude:
|
@@ -1618,7 +1619,7 @@ Chef/Modernize/ResourceForcingCompileTime:
|
|
1618
1619
|
|
1619
1620
|
Chef/Modernize/ExecuteSysctl:
|
1620
1621
|
Description: Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
|
1621
|
-
StyleGuide: '
|
1622
|
+
StyleGuide: 'chef_modernize_executesysctl'
|
1622
1623
|
Enabled: true
|
1623
1624
|
VersionAdded: '5.18.0'
|
1624
1625
|
Exclude:
|
@@ -1628,7 +1629,7 @@ Chef/Modernize/ExecuteSysctl:
|
|
1628
1629
|
|
1629
1630
|
Chef/Modernize/SimplifyAptPpaSetup:
|
1630
1631
|
Description: The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.
|
1631
|
-
StyleGuide: '
|
1632
|
+
StyleGuide: 'chef_modernize_simplifyaptppasetup'
|
1632
1633
|
Enabled: true
|
1633
1634
|
VersionAdded: '5.21.0'
|
1634
1635
|
Exclude:
|
@@ -1638,7 +1639,7 @@ Chef/Modernize/SimplifyAptPpaSetup:
|
|
1638
1639
|
|
1639
1640
|
Chef/Modernize/UseRequireRelative:
|
1640
1641
|
Description: Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
|
1641
|
-
StyleGuide: '
|
1642
|
+
StyleGuide: 'chef_modernize_userequirerelative'
|
1642
1643
|
Enabled: true
|
1643
1644
|
VersionAdded: '5.22.0'
|
1644
1645
|
Exclude:
|
@@ -1648,7 +1649,7 @@ Chef/Modernize/UseRequireRelative:
|
|
1648
1649
|
|
1649
1650
|
Chef/Modernize/NodeInitPackage:
|
1650
1651
|
Description: Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
|
1651
|
-
StyleGuide: '
|
1652
|
+
StyleGuide: 'chef_modernize_nodeinitpackage'
|
1652
1653
|
Enabled: true
|
1653
1654
|
VersionAdded: '5.22.0'
|
1654
1655
|
Exclude:
|
@@ -1657,7 +1658,7 @@ Chef/Modernize/NodeInitPackage:
|
|
1657
1658
|
|
1658
1659
|
Chef/Modernize/WindowsRegistryUAC:
|
1659
1660
|
Description: Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.
|
1660
|
-
StyleGuide: '
|
1661
|
+
StyleGuide: 'chef_modernize_windowsregistryuac'
|
1661
1662
|
Enabled: true
|
1662
1663
|
VersionAdded: '5.22.0'
|
1663
1664
|
Exclude:
|
@@ -1667,7 +1668,7 @@ Chef/Modernize/WindowsRegistryUAC:
|
|
1667
1668
|
|
1668
1669
|
Chef/Modernize/UseMultipackageInstalls:
|
1669
1670
|
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.
|
1670
|
-
StyleGuide: '
|
1671
|
+
StyleGuide: 'chef_modernize_usemultipackageinstalls'
|
1671
1672
|
Enabled: true
|
1672
1673
|
VersionAdded: '6.0.0'
|
1673
1674
|
Exclude:
|
@@ -1677,7 +1678,7 @@ Chef/Modernize/UseMultipackageInstalls:
|
|
1677
1678
|
|
1678
1679
|
Chef/Modernize/ProvidesFromInitialize:
|
1679
1680
|
Description: Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
|
1680
|
-
StyleGuide: '
|
1681
|
+
StyleGuide: 'chef_modernize_providesfrominitialize'
|
1681
1682
|
Enabled: true
|
1682
1683
|
VersionAdded: '6.0.0'
|
1683
1684
|
Include:
|
@@ -1687,7 +1688,7 @@ Chef/Modernize/ProvidesFromInitialize:
|
|
1687
1688
|
|
1688
1689
|
Chef/Modernize/DatabagHelpers:
|
1689
1690
|
Description: Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.
|
1690
|
-
StyleGuide: '
|
1691
|
+
StyleGuide: 'chef_modernize_databaghelpers'
|
1691
1692
|
Enabled: true
|
1692
1693
|
VersionAdded: '6.0.0'
|
1693
1694
|
Exclude:
|
@@ -1696,7 +1697,7 @@ Chef/Modernize/DatabagHelpers:
|
|
1696
1697
|
|
1697
1698
|
Chef/Modernize/NodeRolesInclude:
|
1698
1699
|
Description: Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
|
1699
|
-
StyleGuide: '
|
1700
|
+
StyleGuide: 'chef_modernize_noderolesinclude'
|
1700
1701
|
Enabled: true
|
1701
1702
|
VersionAdded: '6.1.0'
|
1702
1703
|
Exclude:
|
@@ -1705,7 +1706,7 @@ Chef/Modernize/NodeRolesInclude:
|
|
1705
1706
|
|
1706
1707
|
Chef/Modernize/RespondToCompileTime:
|
1707
1708
|
Description: There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
|
1708
|
-
StyleGuide: '
|
1709
|
+
StyleGuide: 'chef_modernize_resondtocompiletime'
|
1709
1710
|
Enabled: true
|
1710
1711
|
VersionAdded: '6.3.0'
|
1711
1712
|
Exclude:
|
@@ -1714,7 +1715,7 @@ Chef/Modernize/RespondToCompileTime:
|
|
1714
1715
|
|
1715
1716
|
Chef/Modernize/ShellOutHelper:
|
1716
1717
|
Description: Use the built-in shell_out helper available in Chef Infra Client 12.11+ instead of calling Mixlib::ShellOut.new('foo').run_command.
|
1717
|
-
StyleGuide: '
|
1718
|
+
StyleGuide: 'chef_modernize_shellouthelper'
|
1718
1719
|
Enabled: true
|
1719
1720
|
VersionAdded: '6.5.0'
|
1720
1721
|
Exclude:
|
@@ -1724,7 +1725,7 @@ Chef/Modernize/ShellOutHelper:
|
|
1724
1725
|
|
1725
1726
|
Chef/Modernize/ConditionalUsingTest:
|
1726
1727
|
Description: Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out.
|
1727
|
-
StyleGuide: '
|
1728
|
+
StyleGuide: 'chef_modernize_conditionalusingtest'
|
1728
1729
|
Enabled: true
|
1729
1730
|
VersionAdded: '6.11.0'
|
1730
1731
|
Exclude:
|
@@ -1734,7 +1735,7 @@ Chef/Modernize/ConditionalUsingTest:
|
|
1734
1735
|
|
1735
1736
|
Chef/Modernize/CronDFileOrTemplate:
|
1736
1737
|
Description: Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources
|
1737
|
-
StyleGuide: '
|
1738
|
+
StyleGuide: 'chef_modernize_crondfileortemplate'
|
1738
1739
|
Enabled: true
|
1739
1740
|
VersionAdded: '6.13.0'
|
1740
1741
|
Exclude:
|
@@ -1744,7 +1745,7 @@ Chef/Modernize/CronDFileOrTemplate:
|
|
1744
1745
|
|
1745
1746
|
Chef/Modernize/ActionMethodInResource:
|
1746
1747
|
Description: Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
|
1747
|
-
StyleGuide: '
|
1748
|
+
StyleGuide: 'chef_modernize_actionmethodinresource'
|
1748
1749
|
Enabled: true
|
1749
1750
|
VersionAdded: '6.13.0'
|
1750
1751
|
Include:
|
@@ -1756,11 +1757,11 @@ Chef/Modernize/ActionMethodInResource:
|
|
1756
1757
|
###############################
|
1757
1758
|
|
1758
1759
|
Chef/RedundantCode:
|
1759
|
-
StyleGuideBaseURL: https://
|
1760
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
1760
1761
|
|
1761
1762
|
Chef/RedundantCode/ConflictsMetadata:
|
1762
1763
|
Description: Don't use the deprecated 'conflicts' metadata value
|
1763
|
-
StyleGuide: '
|
1764
|
+
StyleGuide: 'chef_redundantcode_conflictsmetadata'
|
1764
1765
|
Enabled: true
|
1765
1766
|
VersionAdded: '5.1.0'
|
1766
1767
|
VersionChanged: '5.15.0'
|
@@ -1769,7 +1770,7 @@ Chef/RedundantCode/ConflictsMetadata:
|
|
1769
1770
|
|
1770
1771
|
Chef/RedundantCode/SuggestsMetadata:
|
1771
1772
|
Description: The suggests metadata.rb method is not used and is unnecessary in cookbooks.
|
1772
|
-
StyleGuide: '
|
1773
|
+
StyleGuide: 'chef_redundantcode_suggestsmetadata'
|
1773
1774
|
Enabled: true
|
1774
1775
|
VersionAdded: '5.1.0'
|
1775
1776
|
VersionChanged: '5.15.0'
|
@@ -1778,7 +1779,7 @@ Chef/RedundantCode/SuggestsMetadata:
|
|
1778
1779
|
|
1779
1780
|
Chef/RedundantCode/ProvidesMetadata:
|
1780
1781
|
Description: The provides metadata.rb method is not used and is unnecessary in cookbooks.
|
1781
|
-
StyleGuide: '
|
1782
|
+
StyleGuide: 'chef_redundantcode_providesmetadata'
|
1782
1783
|
Enabled: true
|
1783
1784
|
VersionAdded: '5.1.0'
|
1784
1785
|
VersionChanged: '5.15.0'
|
@@ -1787,7 +1788,7 @@ Chef/RedundantCode/ProvidesMetadata:
|
|
1787
1788
|
|
1788
1789
|
Chef/RedundantCode/ReplacesMetadata:
|
1789
1790
|
Description: The replaces metadata.rb method is not used and is unnecessary in cookbooks.
|
1790
|
-
StyleGuide: '
|
1791
|
+
StyleGuide: 'chef_redundantcode_replacesmetadata'
|
1791
1792
|
Enabled: true
|
1792
1793
|
VersionAdded: '5.1.0'
|
1793
1794
|
VersionChanged: '5.15.0'
|
@@ -1796,7 +1797,7 @@ Chef/RedundantCode/ReplacesMetadata:
|
|
1796
1797
|
|
1797
1798
|
Chef/RedundantCode/AttributeMetadata:
|
1798
1799
|
Description: The attribute metadata.rb method is not used and is unnecessary in cookbooks.
|
1799
|
-
StyleGuide: '
|
1800
|
+
StyleGuide: 'chef_redundantcode_attributemetadata'
|
1800
1801
|
Enabled: true
|
1801
1802
|
VersionAdded: '5.1.0'
|
1802
1803
|
VersionChanged: '5.15.0'
|
@@ -1805,7 +1806,7 @@ Chef/RedundantCode/AttributeMetadata:
|
|
1805
1806
|
|
1806
1807
|
Chef/RedundantCode/LongDescriptionMetadata:
|
1807
1808
|
Description: The long_description metadata.rb method is not used and is unnecessary in cookbooks
|
1808
|
-
StyleGuide: '
|
1809
|
+
StyleGuide: 'chef_redundantcode_longdescriptionmetadata'
|
1809
1810
|
Enabled: true
|
1810
1811
|
VersionAdded: '5.2.0'
|
1811
1812
|
VersionChanged: '5.15.0'
|
@@ -1814,7 +1815,7 @@ Chef/RedundantCode/LongDescriptionMetadata:
|
|
1814
1815
|
|
1815
1816
|
Chef/RedundantCode/RecipeMetadata:
|
1816
1817
|
Description: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the README.md file instead.
|
1817
|
-
StyleGuide: '
|
1818
|
+
StyleGuide: 'chef_redundantcode_recipemetadata'
|
1818
1819
|
Enabled: true
|
1819
1820
|
VersionAdded: '5.6.0'
|
1820
1821
|
VersionChanged: '5.15.0'
|
@@ -1823,7 +1824,7 @@ Chef/RedundantCode/RecipeMetadata:
|
|
1823
1824
|
|
1824
1825
|
Chef/RedundantCode/ResourceWithNothingAction:
|
1825
1826
|
Description: There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.
|
1826
|
-
StyleGuide: '
|
1827
|
+
StyleGuide: 'chef_redundantcode_resourcewithnothingaction'
|
1827
1828
|
Enabled: true
|
1828
1829
|
VersionAdded: '5.12.0'
|
1829
1830
|
VersionChanged: '5.15.0'
|
@@ -1834,7 +1835,7 @@ Chef/RedundantCode/ResourceWithNothingAction:
|
|
1834
1835
|
|
1835
1836
|
Chef/RedundantCode/UnnecessaryNameProperty:
|
1836
1837
|
Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
|
1837
|
-
StyleGuide: '
|
1838
|
+
StyleGuide: 'chef_redundantcode_unnecessarynameproperty'
|
1838
1839
|
Enabled: true
|
1839
1840
|
VersionAdded: '5.8.0'
|
1840
1841
|
VersionChanged: '5.15.0'
|
@@ -1844,7 +1845,7 @@ Chef/RedundantCode/UnnecessaryNameProperty:
|
|
1844
1845
|
|
1845
1846
|
Chef/RedundantCode/PropertyWithRequiredAndDefault:
|
1846
1847
|
Description: Resource property should not be both required and have a default value
|
1847
|
-
StyleGuide: '
|
1848
|
+
StyleGuide: 'chef_redundantcode_propertywithrequiredanddefault'
|
1848
1849
|
Enabled: true
|
1849
1850
|
VersionAdded: '5.1.0'
|
1850
1851
|
VersionChanged: '5.15.0'
|
@@ -1854,7 +1855,7 @@ Chef/RedundantCode/PropertyWithRequiredAndDefault:
|
|
1854
1855
|
|
1855
1856
|
Chef/RedundantCode/NamePropertyIsRequired:
|
1856
1857
|
Description: Resource properties marked as name properties should not also be required properties
|
1857
|
-
StyleGuide: '
|
1858
|
+
StyleGuide: 'chef_redundantcode_namepropertyisrequired'
|
1858
1859
|
Enabled: true
|
1859
1860
|
VersionAdded: '5.1.0'
|
1860
1861
|
VersionChanged: '5.15.0'
|
@@ -1864,7 +1865,7 @@ Chef/RedundantCode/NamePropertyIsRequired:
|
|
1864
1865
|
|
1865
1866
|
Chef/RedundantCode/CustomResourceWithAllowedActions:
|
1866
1867
|
Description: It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
|
1867
|
-
StyleGuide: '
|
1868
|
+
StyleGuide: 'chef_redundantcode_customresourcewithallowedactions'
|
1868
1869
|
Enabled: true
|
1869
1870
|
VersionAdded: '5.2.0'
|
1870
1871
|
VersionChanged: '5.15.0'
|
@@ -1873,7 +1874,7 @@ Chef/RedundantCode/CustomResourceWithAllowedActions:
|
|
1873
1874
|
|
1874
1875
|
Chef/RedundantCode/SensitivePropertyInResource:
|
1875
1876
|
Description: Every Chef Infra resources already include a sensitive property with a default value of false.
|
1876
|
-
StyleGuide: '
|
1877
|
+
StyleGuide: 'chef_redundantcode_sensitivepropertyinresource'
|
1877
1878
|
Enabled: true
|
1878
1879
|
VersionAdded: '5.16.0'
|
1879
1880
|
Include:
|
@@ -1882,7 +1883,7 @@ Chef/RedundantCode/SensitivePropertyInResource:
|
|
1882
1883
|
|
1883
1884
|
Chef/RedundantCode/UnnecessaryDesiredState:
|
1884
1885
|
Description: 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
|
1885
|
-
StyleGuide: '
|
1886
|
+
StyleGuide: 'chef_redundantcode_unnecessarydesiredstate'
|
1886
1887
|
Enabled: true
|
1887
1888
|
VersionAdded: '5.16.0'
|
1888
1889
|
Include:
|
@@ -1891,7 +1892,7 @@ Chef/RedundantCode/UnnecessaryDesiredState:
|
|
1891
1892
|
|
1892
1893
|
Chef/RedundantCode/AptRepositoryNotifiesAptUpdate:
|
1893
1894
|
Description: There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
|
1894
|
-
StyleGuide: '
|
1895
|
+
StyleGuide: 'chef_redundantcode_aptrepositorynotifiesaptupdate'
|
1895
1896
|
Enabled: true
|
1896
1897
|
VersionAdded: '5.17.0'
|
1897
1898
|
Exclude:
|
@@ -1901,7 +1902,7 @@ Chef/RedundantCode/AptRepositoryNotifiesAptUpdate:
|
|
1901
1902
|
|
1902
1903
|
Chef/RedundantCode/AptRepositoryDistributionDefault:
|
1903
1904
|
Description: There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
|
1904
|
-
StyleGuide: '
|
1905
|
+
StyleGuide: 'chef_redundantcode_aptrepositorydistributiondefault'
|
1905
1906
|
Enabled: true
|
1906
1907
|
VersionAdded: '5.17.0'
|
1907
1908
|
Exclude:
|
@@ -1911,7 +1912,7 @@ Chef/RedundantCode/AptRepositoryDistributionDefault:
|
|
1911
1912
|
|
1912
1913
|
Chef/RedundantCode/GroupingMetadata:
|
1913
1914
|
Description: The grouping metadata.rb method is not used and is unnecessary in cookbooks.
|
1914
|
-
StyleGuide: '
|
1915
|
+
StyleGuide: 'chef_redundantcode_groupingmetadata'
|
1915
1916
|
Enabled: true
|
1916
1917
|
VersionAdded: '5.19.0'
|
1917
1918
|
Include:
|
@@ -1919,7 +1920,7 @@ Chef/RedundantCode/GroupingMetadata:
|
|
1919
1920
|
|
1920
1921
|
Chef/RedundantCode/StringPropertyWithNilDefault:
|
1921
1922
|
Description: Properties have a nil value by default so there is no need to set the default value to nil.
|
1922
|
-
StyleGuide: '
|
1923
|
+
StyleGuide: 'chef_redundantcode_stringpropertywithnildefault'
|
1923
1924
|
Enabled: true
|
1924
1925
|
VersionAdded: '5.21.0'
|
1925
1926
|
Include:
|
@@ -1928,7 +1929,7 @@ Chef/RedundantCode/StringPropertyWithNilDefault:
|
|
1928
1929
|
|
1929
1930
|
Chef/RedundantCode/PropertySplatRegex:
|
1930
1931
|
Description: There is no need to validate the input of properties in resources using a regex value that will always pass.
|
1931
|
-
StyleGuide: '
|
1932
|
+
StyleGuide: 'chef_redundantcode_propertysplatregex'
|
1932
1933
|
Enabled: true
|
1933
1934
|
VersionAdded: '5.21.0'
|
1934
1935
|
Include:
|
@@ -1937,7 +1938,7 @@ Chef/RedundantCode/PropertySplatRegex:
|
|
1937
1938
|
|
1938
1939
|
Chef/RedundantCode/UseCreateIfMissing:
|
1939
1940
|
Description: Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.
|
1940
|
-
StyleGuide: '
|
1941
|
+
StyleGuide: 'chef_redundantcode_usecreateifmissing'
|
1941
1942
|
Enabled: true
|
1942
1943
|
VersionAdded: '6.2.0'
|
1943
1944
|
Exclude:
|
@@ -1947,7 +1948,7 @@ Chef/RedundantCode/UseCreateIfMissing:
|
|
1947
1948
|
|
1948
1949
|
Chef/RedundantCode/OhaiAttributeToString:
|
1949
1950
|
Description: Many Ohai node attributes are already strings and don't need to be cast to strings again
|
1950
|
-
StyleGuide: '
|
1951
|
+
StyleGuide: 'chef_redundantcode_ohaiattributetostring'
|
1951
1952
|
Enabled: true
|
1952
1953
|
VersionAdded: '6.10.0'
|
1953
1954
|
Exclude:
|
@@ -1956,7 +1957,7 @@ Chef/RedundantCode/OhaiAttributeToString:
|
|
1956
1957
|
|
1957
1958
|
Chef/RedundantCode/MultiplePlatformChecks:
|
1958
1959
|
Description: You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
|
1959
|
-
StyleGuide: '
|
1960
|
+
StyleGuide: 'chef_redundantcode_multipleplatformchecks'
|
1960
1961
|
Enabled: true
|
1961
1962
|
VersionAdded: '6.10.0'
|
1962
1963
|
Exclude:
|
@@ -1965,7 +1966,7 @@ Chef/RedundantCode/MultiplePlatformChecks:
|
|
1965
1966
|
|
1966
1967
|
Chef/RedundantCode/DoubleCompileTime:
|
1967
1968
|
Description: If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
|
1968
|
-
StyleGuide: '
|
1969
|
+
StyleGuide: 'chef_redundantcode_doublecompiletime'
|
1969
1970
|
Enabled: true
|
1970
1971
|
VersionAdded: '6.13.0'
|
1971
1972
|
Exclude:
|
@@ -1978,11 +1979,11 @@ Chef/RedundantCode/DoubleCompileTime:
|
|
1978
1979
|
###############################
|
1979
1980
|
|
1980
1981
|
Chef/Effortless:
|
1981
|
-
StyleGuideBaseURL: https://
|
1982
|
+
StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
|
1982
1983
|
|
1983
1984
|
Chef/Effortless/CookbookUsesSearch:
|
1984
1985
|
Description: Cookbook uses search, which cannot be used in the Effortless Infra pattern
|
1985
|
-
StyleGuide: '
|
1986
|
+
StyleGuide: 'chef_effortless_cookbookusessearch'
|
1986
1987
|
Enabled: false
|
1987
1988
|
VersionAdded: '5.1.0'
|
1988
1989
|
Exclude:
|
@@ -1991,7 +1992,7 @@ Chef/Effortless/CookbookUsesSearch:
|
|
1991
1992
|
|
1992
1993
|
Chef/Effortless/CookbookUsesDatabags:
|
1993
1994
|
Description: Cookbook uses data bags, which cannot be used in the Effortless Infra pattern
|
1994
|
-
StyleGuide: '
|
1995
|
+
StyleGuide: 'chef_effortless_cookbookusesdatabags'
|
1995
1996
|
Enabled: false
|
1996
1997
|
VersionAdded: '5.1.0'
|
1997
1998
|
Exclude:
|
@@ -2001,7 +2002,7 @@ Chef/Effortless/CookbookUsesDatabags:
|
|
2001
2002
|
# https://github.com/chef/cookstyle/issues/346
|
2002
2003
|
Chef/Effortless/ChefVaultUsed:
|
2003
2004
|
Description: Cookbook uses Chef Vault, which cannot be used in the Effortless Infra pattern
|
2004
|
-
StyleGuide: '
|
2005
|
+
StyleGuide: 'chef_effortless_cookbookuseschefvault'
|
2005
2006
|
Enabled: false
|
2006
2007
|
VersionAdded: '6.19'
|
2007
2008
|
Exclude:
|
@@ -2011,7 +2012,7 @@ Chef/Effortless/ChefVaultUsed:
|
|
2011
2012
|
# https://github.com/chef/cookstyle/issues/346
|
2012
2013
|
Chef/Effortless/DependsChefVault:
|
2013
2014
|
Description: Cookbook depends on Chef Vault, which cannot be used in the Effortless Infra pattern
|
2014
|
-
StyleGuide: '
|
2015
|
+
StyleGuide: 'chef_effortless_cookbookdependschefvault'
|
2015
2016
|
Enabled: false
|
2016
2017
|
VersionAdded: '6.19'
|
2017
2018
|
Include:
|
@@ -2019,7 +2020,7 @@ Chef/Effortless/DependsChefVault:
|
|
2019
2020
|
|
2020
2021
|
Chef/Effortless/CookbookUsesEnvironments:
|
2021
2022
|
Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
|
2022
|
-
StyleGuide: '
|
2023
|
+
StyleGuide: 'chef_effortless_cookbookusesenvironments'
|
2023
2024
|
Enabled: false
|
2024
2025
|
VersionAdded: '5.10.0'
|
2025
2026
|
Exclude:
|
@@ -2028,7 +2029,7 @@ Chef/Effortless/CookbookUsesEnvironments:
|
|
2028
2029
|
|
2029
2030
|
Chef/Effortless/CookbookUsesPolicygroups:
|
2030
2031
|
Description: Cookbook uses Policy Groups, which cannot be used in the Effortless Infra pattern
|
2031
|
-
StyleGuide: '
|
2032
|
+
StyleGuide: 'chef_effortless_cookbookusespolicygroups'
|
2032
2033
|
Enabled: false
|
2033
2034
|
VersionAdded: '5.10.0'
|
2034
2035
|
Exclude:
|
@@ -2037,7 +2038,7 @@ Chef/Effortless/CookbookUsesPolicygroups:
|
|
2037
2038
|
|
2038
2039
|
Chef/Effortless/CookbookUsesRoles:
|
2039
2040
|
Description: Cookbook uses Roles, which cannot be used in the Effortless Infra pattern
|
2040
|
-
StyleGuide: '
|
2041
|
+
StyleGuide: 'chef_effortless_cookbookusesroles'
|
2041
2042
|
Enabled: false
|
2042
2043
|
VersionAdded: '5.10.0'
|
2043
2044
|
Exclude:
|
@@ -2046,7 +2047,7 @@ Chef/Effortless/CookbookUsesRoles:
|
|
2046
2047
|
|
2047
2048
|
Chef/Effortless/SearchForEnvironmentsOrRoles:
|
2048
2049
|
Description: Cookbook uses search with a node query that looks for a role or environment
|
2049
|
-
StyleGuide: '
|
2050
|
+
StyleGuide: 'chef_effortless_searchforenvironmentsorroles'
|
2050
2051
|
Enabled: false
|
2051
2052
|
VersionAdded: '5.11.0'
|
2052
2053
|
Exclude:
|
@@ -2055,7 +2056,7 @@ Chef/Effortless/SearchForEnvironmentsOrRoles:
|
|
2055
2056
|
|
2056
2057
|
Chef/Effortless/Berksfile:
|
2057
2058
|
Description: Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
|
2058
|
-
StyleGuide: '
|
2059
|
+
StyleGuide: 'chef_effortless_berksfile'
|
2059
2060
|
Enabled: false
|
2060
2061
|
VersionAdded: '5.12.0'
|
2061
2062
|
Include:
|