Skip to content

Commit 1e28562

Browse files
committed
Unify key order in the config
1. Description 2. Enabled 3. Exclude 4. Styles 5. Versions 6. StyleGuide
1 parent bbff18c commit 1e28562

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

config/default.yml

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ RSpec/BeEql:
4949
RSpec/BeforeAfterAll:
5050
Description: Check that before/after(:all) isn't being used.
5151
Enabled: true
52-
VersionAdded: '1.12'
5352
Exclude:
5453
- spec/spec_helper.rb
5554
- spec/rails_helper.rb
5655
- spec/support/**/*.rb
56+
VersionAdded: '1.12'
5757
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeforeAfterAll
5858

5959
RSpec/ContextMethod:
@@ -65,12 +65,12 @@ RSpec/ContextMethod:
6565
RSpec/ContextWording:
6666
Description: Checks that `context` docstring starts with an allowed prefix.
6767
Enabled: true
68-
VersionAdded: '1.20'
69-
VersionChanged: '1.20.1'
7068
Prefixes:
7169
- when
7270
- with
7371
- without
72+
VersionAdded: '1.20'
73+
VersionChanged: 1.20.1
7474
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ContextWording
7575

7676
RSpec/DescribeClass:
@@ -94,13 +94,13 @@ RSpec/DescribeSymbol:
9494
RSpec/DescribedClass:
9595
Description: Checks that tests use `described_class`.
9696
Enabled: true
97-
VersionAdded: '1.0'
98-
VersionChanged: '1.11'
9997
SkipBlocks: false
10098
EnforcedStyle: described_class
10199
SupportedStyles:
102100
- described_class
103101
- explicit
102+
VersionAdded: '1.0'
103+
VersionChanged: '1.11'
104104
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribedClass
105105

106106
RSpec/DescribedClassModuleWrapping:
@@ -112,15 +112,15 @@ RSpec/DescribedClassModuleWrapping:
112112
RSpec/Dialect:
113113
Description: This cop enforces custom RSpec dialects.
114114
Enabled: false
115-
VersionAdded: '1.33'
116115
PreferredMethods: {}
116+
VersionAdded: '1.33'
117117
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Dialect
118118

119119
RSpec/EmptyExampleGroup:
120120
Description: Checks if an example group does not include any tests.
121121
Enabled: true
122-
VersionAdded: '1.7'
123122
CustomIncludeMethods: []
123+
VersionAdded: '1.7'
124124
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup
125125

126126
RSpec/EmptyHook:
@@ -132,8 +132,8 @@ RSpec/EmptyHook:
132132
RSpec/EmptyLineAfterExample:
133133
Description: Checks if there is an empty line after example blocks.
134134
Enabled: true
135-
VersionAdded: '1.36'
136135
AllowConsecutiveOneLiners: true
136+
VersionAdded: '1.36'
137137
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyLineAfterExample
138138

139139
RSpec/EmptyLineAfterExampleGroup:
@@ -163,56 +163,56 @@ RSpec/EmptyLineAfterSubject:
163163
RSpec/ExampleLength:
164164
Description: Checks for long examples.
165165
Enabled: true
166-
VersionAdded: '1.5'
167166
Max: 5
167+
VersionAdded: '1.5'
168168
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleLength
169169

170170
RSpec/ExampleWithoutDescription:
171171
Description: Checks for examples without a description.
172172
Enabled: true
173-
VersionAdded: '1.22'
174173
EnforcedStyle: always_allow
175174
SupportedStyles:
176175
- always_allow
177176
- single_line_only
178177
- disallow
178+
VersionAdded: '1.22'
179179
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWithoutDescription
180180

181181
RSpec/ExampleWording:
182182
Description: Checks for common mistakes in example descriptions.
183183
Enabled: true
184-
VersionAdded: '1.0'
185-
VersionChanged: '1.2'
186184
CustomTransform:
187185
be: is
188186
BE: IS
189187
have: has
190188
HAVE: HAS
191189
IgnoredWords: []
190+
VersionAdded: '1.0'
191+
VersionChanged: '1.2'
192192
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWording
193193

194194
RSpec/ExpectActual:
195195
Description: Checks for `expect(...)` calls containing literal values.
196196
Enabled: true
197-
VersionAdded: '1.7'
198197
Exclude:
199198
- spec/routing/**/*
199+
VersionAdded: '1.7'
200200
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectActual
201201

202202
RSpec/ExpectChange:
203203
Description: Checks for consistent style of change matcher.
204204
Enabled: true
205-
VersionAdded: '1.22'
206205
EnforcedStyle: method_call
207206
SupportedStyles:
208207
- method_call
209208
- block
209+
VersionAdded: '1.22'
210210
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectChange
211211

212212
RSpec/ExpectInHook:
213+
Description: Do not use `expect` in hooks such as `before`.
213214
Enabled: true
214215
VersionAdded: '1.16'
215-
Description: Do not use `expect` in hooks such as `before`.
216216
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectInHook
217217

218218
RSpec/ExpectOutput:
@@ -224,12 +224,12 @@ RSpec/ExpectOutput:
224224
RSpec/FilePath:
225225
Description: Checks that spec file paths are consistent and well-formed.
226226
Enabled: true
227-
VersionAdded: '1.2'
228227
CustomTransform:
229228
RuboCop: rubocop
230229
RSpec: rspec
231230
IgnoreMethods: false
232231
SpecSuffixOnly: false
232+
VersionAdded: '1.2'
233233
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FilePath
234234

235235
RSpec/Focus:
@@ -241,12 +241,12 @@ RSpec/Focus:
241241
RSpec/HookArgument:
242242
Description: Checks the arguments passed to `before`, `around`, and `after`.
243243
Enabled: true
244-
VersionAdded: '1.7'
245244
EnforcedStyle: implicit
246245
SupportedStyles:
247246
- implicit
248247
- each
249248
- example
249+
VersionAdded: '1.7'
250250
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/HookArgument
251251

252252
RSpec/HooksBeforeExamples:
@@ -264,23 +264,23 @@ RSpec/ImplicitBlockExpectation:
264264
RSpec/ImplicitExpect:
265265
Description: Check that a consistent implicit expectation style is used.
266266
Enabled: true
267-
VersionAdded: '1.8'
268267
EnforcedStyle: is_expected
269268
SupportedStyles:
270269
- is_expected
271270
- should
271+
VersionAdded: '1.8'
272272
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitExpect
273273

274274
RSpec/ImplicitSubject:
275275
Description: Checks for usage of implicit subject (`is_expected` / `should`).
276276
Enabled: true
277-
VersionAdded: '1.29'
278-
VersionChanged: '1.30'
279277
EnforcedStyle: single_line_only
280278
SupportedStyles:
281279
- single_line_only
282280
- single_statement_only
283281
- disallow
282+
VersionAdded: '1.29'
283+
VersionChanged: '1.30'
284284
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ImplicitSubject
285285

286286
RSpec/InstanceSpy:
@@ -292,9 +292,9 @@ RSpec/InstanceSpy:
292292
RSpec/InstanceVariable:
293293
Description: Checks for instance variable usage in specs.
294294
Enabled: true
295+
AssignmentOnly: false
295296
VersionAdded: '1.0'
296297
VersionChanged: '1.7'
297-
AssignmentOnly: false
298298
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/InstanceVariable
299299

300300
RSpec/InvalidPredicateMatcher:
@@ -306,11 +306,11 @@ RSpec/InvalidPredicateMatcher:
306306
RSpec/ItBehavesLike:
307307
Description: Checks that only one `it_behaves_like` style is used.
308308
Enabled: true
309-
VersionAdded: '1.13'
310309
EnforcedStyle: it_behaves_like
311310
SupportedStyles:
312311
- it_behaves_like
313312
- it_should_behave_like
313+
VersionAdded: '1.13'
314314
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ItBehavesLike
315315

316316
RSpec/IteratedExpectation:
@@ -354,22 +354,22 @@ RSpec/MessageChain:
354354
RSpec/MessageExpectation:
355355
Description: Checks for consistent message expectation style.
356356
Enabled: false
357-
VersionAdded: '1.7'
358-
VersionChanged: '1.8'
359357
EnforcedStyle: allow
360358
SupportedStyles:
361359
- allow
362360
- expect
361+
VersionAdded: '1.7'
362+
VersionChanged: '1.8'
363363
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MessageExpectation
364364

365365
RSpec/MessageSpies:
366366
Description: Checks that message expectations are set using spies.
367367
Enabled: true
368-
VersionAdded: '1.9'
369368
EnforcedStyle: have_received
370369
SupportedStyles:
371370
- have_received
372371
- receive
372+
VersionAdded: '1.9'
373373
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MessageSpies
374374

375375
RSpec/MissingExampleGroupArgument:
@@ -387,9 +387,9 @@ RSpec/MultipleDescribes:
387387
RSpec/MultipleExpectations:
388388
Description: Checks if examples contain too many `expect` calls.
389389
Enabled: true
390+
Max: 1
390391
VersionAdded: '1.7'
391392
VersionChanged: '1.21'
392-
Max: 1
393393
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleExpectations
394394

395395
RSpec/MultipleSubjects:
@@ -401,26 +401,26 @@ RSpec/MultipleSubjects:
401401
RSpec/NamedSubject:
402402
Description: Checks for explicitly referenced test subjects.
403403
Enabled: true
404-
VersionAdded: '1.5.3'
405404
IgnoreSharedExamples: true
405+
VersionAdded: 1.5.3
406406
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NamedSubject
407407

408408
RSpec/NestedGroups:
409409
Description: Checks for nested example groups.
410410
Enabled: true
411+
Max: 3
411412
VersionAdded: '1.7'
412413
VersionChanged: '1.10'
413-
Max: 3
414414
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NestedGroups
415415

416416
RSpec/NotToNot:
417417
Description: Checks for consistent method usage for negating expectations.
418418
Enabled: true
419-
VersionAdded: '1.4'
420419
EnforcedStyle: not_to
421420
SupportedStyles:
422421
- not_to
423422
- to_not
423+
VersionAdded: '1.4'
424424
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NotToNot
425425

426426
RSpec/OverwritingSetup:
@@ -438,13 +438,13 @@ RSpec/Pending:
438438
RSpec/PredicateMatcher:
439439
Description: Prefer using predicate matcher over using predicate method directly.
440440
Enabled: true
441-
VersionAdded: '1.16'
442441
Strict: true
443442
EnforcedStyle: inflected
444443
AllowedExplicitMatchers: []
445444
SupportedStyles:
446445
- inflected
447446
- explicit
447+
VersionAdded: '1.16'
448448
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/PredicateMatcher
449449

450450
RSpec/ReceiveCounts:
@@ -486,12 +486,12 @@ RSpec/RepeatedExampleGroupDescription:
486486
RSpec/ReturnFromStub:
487487
Description: Checks for consistent style of stub's return setting.
488488
Enabled: true
489-
VersionAdded: '1.16'
490-
VersionChanged: '1.22'
491489
EnforcedStyle: and_return
492490
SupportedStyles:
493491
- and_return
494492
- block
493+
VersionAdded: '1.16'
494+
VersionChanged: '1.22'
495495
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReturnFromStub
496496

497497
RSpec/ScatteredLet:
@@ -561,10 +561,10 @@ RSpec/VariableName:
561561
RSpec/VerifiedDoubles:
562562
Description: Prefer using verifying doubles over normal doubles.
563563
Enabled: true
564-
VersionAdded: '1.2.1'
565-
VersionChanged: '1.5'
566564
IgnoreNameless: true
567565
IgnoreSymbolicNames: false
566+
VersionAdded: 1.2.1
567+
VersionChanged: '1.5'
568568
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VerifiedDoubles
569569

570570
RSpec/VoidExpect:
@@ -588,9 +588,9 @@ Capybara/CurrentPathExpectation:
588588
Capybara/FeatureMethods:
589589
Description: Checks for consistent method usage in feature specs.
590590
Enabled: true
591+
EnabledMethods: []
591592
VersionAdded: '1.17'
592593
VersionChanged: '1.25'
593-
EnabledMethods: []
594594
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/FeatureMethods
595595

596596
Capybara/VisibilityMatcher:
@@ -608,11 +608,11 @@ FactoryBot/AttributeDefinedStatically:
608608
FactoryBot/CreateList:
609609
Description: Checks for create_list usage.
610610
Enabled: true
611-
VersionAdded: '1.25'
612611
EnforcedStyle: create_list
613612
SupportedStyles:
614613
- create_list
615614
- n_times
615+
VersionAdded: '1.25'
616616
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/CreateList
617617

618618
FactoryBot/FactoryClassName:
@@ -624,9 +624,9 @@ FactoryBot/FactoryClassName:
624624
Rails/HttpStatus:
625625
Description: Enforces use of symbolic or numeric value to describe HTTP status.
626626
Enabled: true
627-
VersionAdded: '1.23'
628627
EnforcedStyle: symbolic
629628
SupportedStyles:
630629
- numeric
631630
- symbolic
631+
VersionAdded: '1.23'
632632
StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/HttpStatus

0 commit comments

Comments
 (0)