/
full_config.yml
3921 lines (3921 loc) · 109 KB
/
full_config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
AllCops:
RubyInterpreters:
- ruby
- macruby
- rake
- jruby
- rbx
Include:
- "**/*.rb"
- "**/*.arb"
- "**/*.axlsx"
- "**/*.builder"
- "**/*.fcgi"
- "**/*.gemfile"
- "**/*.gemspec"
- "**/*.god"
- "**/*.jb"
- "**/*.jbuilder"
- "**/*.mspec"
- "**/*.opal"
- "**/*.pluginspec"
- "**/*.podspec"
- "**/*.rabl"
- "**/*.rake"
- "**/*.rbuild"
- "**/*.rbw"
- "**/*.rbx"
- "**/*.ru"
- "**/*.ruby"
- "**/*.spec"
- "**/*.thor"
- "**/*.watchr"
- "**/.irbrc"
- "**/.pryrc"
- "**/.simplecov"
- "**/buildfile"
- "**/Appraisals"
- "**/Berksfile"
- "**/Brewfile"
- "**/Buildfile"
- "**/Capfile"
- "**/Cheffile"
- "**/Dangerfile"
- "**/Deliverfile"
- "**/Fastfile"
- "**/*Fastfile"
- "**/Gemfile"
- "**/Guardfile"
- "**/Jarfile"
- "**/Mavenfile"
- "**/Podfile"
- "**/Puppetfile"
- "**/Rakefile"
- "**/rakefile"
- "**/Snapfile"
- "**/Steepfile"
- "**/Thorfile"
- "**/Vagabondfile"
- "**/Vagrantfile"
Exclude:
- "/node_modules/**/*"
- "/tmp/**/*"
- "/vendor/**/*"
- "/.git/**/*"
DefaultFormatter: progress
DisplayCopNames: true
DisplayStyleGuide: false
StyleGuideBaseURL: https://shopify.github.io/ruby-style-guide/
DocumentationBaseURL: https://docs.rubocop.org/rubocop
ExtraDetails: false
StyleGuideCopsOnly: false
EnabledByDefault: false
DisabledByDefault: false
NewCops: pending
UseCache: true
MaxFilesInCache: 20000
CacheRootDirectory:
AllowSymlinksInCacheRootDirectory: false
TargetRubyVersion:
SuggestExtensions:
rubocop-rails:
- rails
rubocop-rspec:
- rspec
- rspec-rails
rubocop-minitest:
- minitest
rubocop-sequel:
- sequel
rubocop-rake:
- rake
rubocop-graphql:
- graphql
Bundler/DuplicatedGem:
Description: Checks for duplicate gem entries in Gemfile.
Enabled: true
VersionAdded: '0.46'
Include:
- "**/*.gemfile"
- "**/Gemfile"
- "**/gems.rb"
Bundler/GemComment:
Description: Add a comment describing each gem.
Enabled: false
VersionAdded: '0.59'
VersionChanged: '0.85'
Include:
- "**/*.gemfile"
- "**/Gemfile"
- "**/gems.rb"
IgnoredGems: []
OnlyFor: []
Bundler/GemFilename:
Description: Enforces the filename for managing gems.
Enabled: true
VersionAdded: '1.20'
EnforcedStyle: Gemfile
SupportedStyles:
- Gemfile
- gems.rb
Include:
- "**/Gemfile"
- "**/gems.rb"
- "**/Gemfile.lock"
- "**/gems.locked"
Bundler/GemVersion:
Description: Requires or forbids specifying gem versions.
Enabled: false
VersionAdded: '1.14'
EnforcedStyle: required
SupportedStyles:
- required
- forbidden
Include:
- "**/*.gemfile"
- "**/Gemfile"
- "**/gems.rb"
AllowedGems: []
Bundler/InsecureProtocolSource:
Description: The source `:gemcutter`, `:rubygems` and `:rubyforge` are deprecated
because HTTP requests are insecure. Please change your source to 'https://rubygems.org'
if possible, or 'http://rubygems.org' if not.
Enabled: true
VersionAdded: '0.50'
AllowHttpProtocol: true
Include:
- "**/*.gemfile"
- "**/Gemfile"
- "**/gems.rb"
Bundler/OrderedGems:
Description: Gems within groups in the Gemfile should be alphabetically sorted.
Enabled: false
VersionAdded: '0.46'
VersionChanged: '0.47'
TreatCommentsAsGroupSeparators: true
ConsiderPunctuation: false
Include:
- "**/*.gemfile"
- "**/Gemfile"
- "**/gems.rb"
Gemspec/DateAssignment:
Description: Checks that `date =` is not used in gemspec file, it is set automatically
when the gem is packaged.
Enabled: true
VersionAdded: '1.10'
Include:
- "**/*.gemspec"
Gemspec/DependencyVersion:
Description: Requires or forbids specifying gem dependency versions.
Enabled: false
VersionAdded: '1.29'
EnforcedStyle: required
SupportedStyles:
- required
- forbidden
Include:
- "**/*.gemspec"
AllowedGems: []
Gemspec/DuplicatedAssignment:
Description: An attribute assignment method calls should be listed only once in
a gemspec.
Enabled: true
VersionAdded: '0.52'
Include:
- "**/*.gemspec"
Gemspec/OrderedDependencies:
Description: Dependencies in the gemspec should be alphabetically sorted.
Enabled: true
VersionAdded: '0.51'
TreatCommentsAsGroupSeparators: true
ConsiderPunctuation: false
Include:
- "**/*.gemspec"
Gemspec/RequireMFA:
Description: Checks that the gemspec has metadata to require Multi-Factor Authentication
from RubyGems.
Enabled: false
VersionAdded: '1.23'
Reference:
- https://guides.rubygems.org/mfa-requirement-opt-in/
Include:
- "**/*.gemspec"
Gemspec/RequiredRubyVersion:
Description: Checks that `required_ruby_version` of gemspec is specified and equal
to `TargetRubyVersion` of .rubocop.yml.
Enabled: false
VersionAdded: '0.52'
VersionChanged: '1.22'
Include:
- "**/*.gemspec"
Gemspec/RubyVersionGlobalsUsage:
Description: Checks usage of RUBY_VERSION in gemspec.
StyleGuide: "#no-ruby-version-in-the-gemspec"
Enabled: true
VersionAdded: '0.72'
Include:
- "**/*.gemspec"
Layout/AccessModifierIndentation:
Description: Check indentation of private/protected visibility modifiers.
StyleGuide: "#indent-public-private-protected"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: indent
SupportedStyles:
- outdent
- indent
IndentationWidth:
Layout/ArgumentAlignment:
Description: Align the arguments of a method call if they span more than one line.
StyleGuide: "#no-double-indent"
Enabled: true
VersionAdded: '0.68'
VersionChanged: '0.77'
EnforcedStyle: with_fixed_indentation
SupportedStyles:
- with_first_argument
- with_fixed_indentation
IndentationWidth:
Layout/ArrayAlignment:
Description: Align the elements of an array literal if they span more than one line.
StyleGuide: "#no-double-indent"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.77'
EnforcedStyle: with_first_element
SupportedStyles:
- with_first_element
- with_fixed_indentation
IndentationWidth:
Layout/AssignmentIndentation:
Description: Checks the indentation of the first line of the right-hand-side of
a multi-line assignment.
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.77'
IndentationWidth:
Layout/BeginEndAlignment:
Description: Align ends corresponding to begins correctly.
Enabled: true
VersionAdded: '0.91'
EnforcedStyleAlignWith: start_of_line
SupportedStylesAlignWith:
- start_of_line
- begin
Severity: warning
Layout/BlockAlignment:
Description: Align block ends correctly.
Enabled: true
VersionAdded: '0.53'
EnforcedStyleAlignWith: either
SupportedStylesAlignWith:
- either
- start_of_block
- start_of_line
Layout/BlockEndNewline:
Description: Put end statement of multiline block on its own line.
Enabled: true
VersionAdded: '0.49'
Layout/CaseIndentation:
Description: Indentation of when in a case/(when|in)/[else/]end.
StyleGuide: "#indent-when-to-case"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '1.16'
EnforcedStyle: end
SupportedStyles:
- case
- end
IndentOneStep: false
IndentationWidth:
Layout/ClassStructure:
Description: Enforces a configured order of definitions within a class body.
StyleGuide: "#consistent-classes"
Enabled: false
VersionAdded: '0.52'
Categories:
module_inclusion:
- include
- prepend
- extend
ExpectedOrder:
- module_inclusion
- constants
- public_class_methods
- initializer
- public_methods
- protected_methods
- private_methods
Layout/ClosingHeredocIndentation:
Description: Checks the indentation of here document closings.
Enabled: true
VersionAdded: '0.57'
Layout/ClosingParenthesisIndentation:
Description: Checks the indentation of hanging closing parentheses.
Enabled: true
VersionAdded: '0.49'
Layout/CommentIndentation:
Description: Indentation of comments.
Enabled: true
AllowForAlignment: false
VersionAdded: '0.49'
VersionChanged: '1.24'
Layout/ConditionPosition:
Description: Checks for condition placed in a confusing position relative to the
keyword.
StyleGuide: "#same-line-condition"
Enabled: true
VersionAdded: '0.53'
VersionChanged: '0.83'
Layout/DefEndAlignment:
Description: Align ends corresponding to defs correctly.
Enabled: true
VersionAdded: '0.53'
EnforcedStyleAlignWith: start_of_line
SupportedStylesAlignWith:
- start_of_line
- def
Severity: warning
Layout/DotPosition:
Description: Checks the position of the dot in multi-line method calls.
StyleGuide: "#consistent-multi-line-chains"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: leading
SupportedStyles:
- leading
- trailing
Layout/ElseAlignment:
Description: Align elses and elsifs correctly.
Enabled: true
VersionAdded: '0.49'
Layout/EmptyComment:
Description: Checks empty comment.
Enabled: true
VersionAdded: '0.53'
AllowBorderComment: true
AllowMarginComment: true
Layout/EmptyLineAfterGuardClause:
Description: Add empty line after guard clause.
Enabled: true
VersionAdded: '0.56'
VersionChanged: '0.59'
Layout/EmptyLineAfterMagicComment:
Description: Add an empty line after magic comments to separate them from code.
StyleGuide: "#separate-magic-comments-from-code"
Enabled: true
VersionAdded: '0.49'
Layout/EmptyLineAfterMultilineCondition:
Description: Enforces empty line after multiline condition.
Enabled: false
VersionAdded: '0.90'
Reference:
- https://github.com/airbnb/ruby#multiline-if-newline
Layout/EmptyLineBetweenDefs:
Description: Use empty lines between class/module/method defs.
StyleGuide: "#empty-lines-between-methods"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '1.23'
EmptyLineBetweenMethodDefs: true
EmptyLineBetweenClassDefs: true
EmptyLineBetweenModuleDefs: true
AllowAdjacentOneLineDefs: true
NumberOfEmptyLines: 1
Layout/EmptyLines:
Description: Don't use several empty lines in a row.
StyleGuide: "#two-or-more-empty-lines"
Enabled: true
VersionAdded: '0.49'
Layout/EmptyLinesAroundAccessModifier:
Description: Keep blank lines around access modifiers.
StyleGuide: "#empty-lines-around-access-modifier"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: around
SupportedStyles:
- around
- only_before
Reference:
- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
Layout/EmptyLinesAroundArguments:
Description: Keeps track of empty lines around method arguments.
Enabled: true
VersionAdded: '0.52'
Layout/EmptyLinesAroundAttributeAccessor:
Description: Keep blank lines around attribute accessors.
StyleGuide: "#empty-lines-around-attribute-accessor"
Enabled: true
VersionAdded: '0.83'
VersionChanged: '0.84'
AllowAliasSyntax: true
AllowedMethods:
- alias_method
- public
- protected
- private
Layout/EmptyLinesAroundBeginBody:
Description: Keeps track of empty lines around begin-end bodies.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
Layout/EmptyLinesAroundBlockBody:
Description: Keeps track of empty lines around block bodies.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: no_empty_lines
SupportedStyles:
- empty_lines
- no_empty_lines
Layout/EmptyLinesAroundClassBody:
Description: Keeps track of empty lines around class bodies.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.53'
EnforcedStyle: no_empty_lines
SupportedStyles:
- empty_lines
- empty_lines_except_namespace
- empty_lines_special
- no_empty_lines
- beginning_only
- ending_only
Layout/EmptyLinesAroundExceptionHandlingKeywords:
Description: Keeps track of empty lines around exception handling keywords.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
Layout/EmptyLinesAroundMethodBody:
Description: Keeps track of empty lines around method bodies.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
Layout/EmptyLinesAroundModuleBody:
Description: Keeps track of empty lines around module bodies.
StyleGuide: "#empty-lines-around-bodies"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: no_empty_lines
SupportedStyles:
- empty_lines
- empty_lines_except_namespace
- empty_lines_special
- no_empty_lines
Layout/EndAlignment:
Description: Align ends correctly.
Enabled: true
VersionAdded: '0.53'
EnforcedStyleAlignWith: variable
SupportedStylesAlignWith:
- keyword
- variable
- start_of_line
Severity: warning
Layout/EndOfLine:
Description: Use Unix-style line endings.
StyleGuide: "#crlf"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: native
SupportedStyles:
- native
- lf
- crlf
Layout/ExtraSpacing:
Description: Do not use unnecessary spacing.
Enabled: true
VersionAdded: '0.49'
AllowForAlignment: true
AllowBeforeTrailingComments: false
ForceEqualSignAlignment: false
Layout/FirstArgumentIndentation:
Description: Checks the indentation of the first argument in a method call.
Enabled: false
VersionAdded: '0.68'
VersionChanged: '0.77'
EnforcedStyle: special_for_inner_method_call_in_parentheses
SupportedStyles:
- consistent
- consistent_relative_to_receiver
- special_for_inner_method_call
- special_for_inner_method_call_in_parentheses
IndentationWidth:
Layout/FirstArrayElementIndentation:
Description: Checks the indentation of the first element in an array literal.
Enabled: true
VersionAdded: '0.68'
VersionChanged: '0.77'
EnforcedStyle: consistent
SupportedStyles:
- special_inside_parentheses
- consistent
- align_brackets
IndentationWidth:
Layout/FirstArrayElementLineBreak:
Description: Checks for a line break before the first element in a multi-line array.
Enabled: false
VersionAdded: '0.49'
Layout/FirstHashElementIndentation:
Description: Checks the indentation of the first key in a hash literal.
Enabled: true
VersionAdded: '0.68'
VersionChanged: '0.77'
EnforcedStyle: consistent
SupportedStyles:
- special_inside_parentheses
- consistent
- align_braces
IndentationWidth:
Layout/FirstHashElementLineBreak:
Description: Checks for a line break before the first element in a multi-line hash.
Enabled: false
VersionAdded: '0.49'
Layout/FirstMethodArgumentLineBreak:
Description: Checks for a line break before the first argument in a multi-line method
call.
Enabled: false
VersionAdded: '0.49'
Layout/FirstMethodParameterLineBreak:
Description: Checks for a line break before the first parameter in a multi-line
method parameter definition.
Enabled: false
VersionAdded: '0.49'
Layout/FirstParameterIndentation:
Description: Checks the indentation of the first parameter in a method definition.
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.77'
EnforcedStyle: consistent
SupportedStyles:
- consistent
- align_parentheses
IndentationWidth:
Layout/HashAlignment:
Description: Align the elements of a hash literal if they span more than one line.
Enabled: true
AllowMultipleStyles: true
VersionAdded: '0.49'
VersionChanged: '1.16'
EnforcedHashRocketStyle: key
SupportedHashRocketStyles:
- key
- separator
- table
EnforcedColonStyle: key
SupportedColonStyles:
- key
- separator
- table
EnforcedLastArgumentHashStyle: ignore_implicit
SupportedLastArgumentHashStyles:
- always_inspect
- always_ignore
- ignore_implicit
- ignore_explicit
Layout/HeredocArgumentClosingParenthesis:
Description: Checks for the placement of the closing parenthesis in a method call
that passes a HEREDOC string as an argument.
Enabled: false
StyleGuide: "#heredoc-argument-closing-parentheses"
VersionAdded: '0.68'
Layout/HeredocIndentation:
Description: Checks the indentation of the here document bodies.
StyleGuide: "#squiggly-heredocs"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.85'
Layout/IndentationConsistency:
Description: Keep indentation straight.
StyleGuide: "#spaces-indentation"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: normal
SupportedStyles:
- normal
- indented_internal_methods
Reference:
- https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
Layout/IndentationStyle:
Description: Consistent indentation either with tabs only or spaces only.
StyleGuide: "#spaces-indentation"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.82'
IndentationWidth:
EnforcedStyle: spaces
SupportedStyles:
- spaces
- tabs
Layout/IndentationWidth:
Description: Use 2 spaces for indentation.
StyleGuide: "#spaces-indentation"
Enabled: true
VersionAdded: '0.49'
Width: 2
AllowedPatterns: []
IgnoredPatterns: []
Layout/InitialIndentation:
Description: Checks the indentation of the first non-blank non-comment line in a
file.
Enabled: true
VersionAdded: '0.49'
Layout/LeadingCommentSpace:
Description: Comments should start with a space.
StyleGuide: "#hash-space"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.73'
AllowDoxygenCommentStyle: false
AllowGemfileRubyComment: false
Layout/LeadingEmptyLines:
Description: Check for unnecessary blank lines at the beginning of a file.
Enabled: true
VersionAdded: '0.57'
VersionChanged: '0.77'
Layout/LineEndStringConcatenationIndentation:
Description: Checks the indentation of the next line after a line that ends with
a string literal and a backslash.
Enabled: true
VersionAdded: '1.18'
EnforcedStyle: indented
SupportedStyles:
- aligned
- indented
IndentationWidth:
Layout/LineLength:
Description: Checks that line length does not exceed the configured limit.
StyleGuide: "#max-line-length"
Enabled: true
VersionAdded: '0.25'
VersionChanged: '1.4'
Max: 120
AllowHeredoc: true
AllowURI: true
URISchemes:
- http
- https
IgnoreCopDirectives: false
AllowedPatterns:
- "\\A\\s*(remote_)?test(_\\w+)?\\s.*(do|->)(\\s|\\Z)"
IgnoredPatterns: []
Layout/MultilineArrayBraceLayout:
Description: Checks that the closing brace in an array literal is either on the
same line as the last array element, or a new line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: symmetrical
SupportedStyles:
- symmetrical
- new_line
- same_line
Layout/MultilineArrayLineBreaks:
Description: Checks that each item in a multi-line array literal starts on a separate
line.
Enabled: false
VersionAdded: '0.67'
Layout/MultilineAssignmentLayout:
Description: Check for a newline after the assignment operator in multi-line assignments.
StyleGuide: "#indent-conditional-assignment"
Enabled: false
VersionAdded: '0.49'
SupportedTypes:
- block
- case
- class
- if
- kwbegin
- module
EnforcedStyle: new_line
SupportedStyles:
- same_line
- new_line
Layout/MultilineBlockLayout:
Description: Ensures newlines after multiline block do statements.
Enabled: true
VersionAdded: '0.49'
Layout/MultilineHashBraceLayout:
Description: Checks that the closing brace in a hash literal is either on the same
line as the last hash element, or a new line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: symmetrical
SupportedStyles:
- symmetrical
- new_line
- same_line
Layout/MultilineHashKeyLineBreaks:
Description: Checks that each item in a multi-line hash literal starts on a separate
line.
Enabled: false
VersionAdded: '0.67'
Layout/MultilineMethodArgumentLineBreaks:
Description: Checks that each argument in a multi-line method call starts on a separate
line.
Enabled: false
VersionAdded: '0.67'
Layout/MultilineMethodCallBraceLayout:
Description: Checks that the closing brace in a method call is either on the same
line as the last method argument, or a new line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: symmetrical
SupportedStyles:
- symmetrical
- new_line
- same_line
Layout/MultilineMethodCallIndentation:
Description: Checks indentation of method calls with the dot operator that span
more than one line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: indented
SupportedStyles:
- aligned
- indented
- indented_relative_to_receiver
IndentationWidth: 2
Layout/MultilineMethodDefinitionBraceLayout:
Description: Checks that the closing brace in a method definition is either on the
same line as the last method parameter, or a new line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: symmetrical
SupportedStyles:
- symmetrical
- new_line
- same_line
Layout/MultilineOperationIndentation:
Description: Checks indentation of binary operations that span more than one line.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: indented
SupportedStyles:
- aligned
- indented
IndentationWidth:
Layout/ParameterAlignment:
Description: Align the parameters of a method definition if they span more than
one line.
StyleGuide: "#no-double-indent"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.77'
EnforcedStyle: with_fixed_indentation
SupportedStyles:
- with_first_parameter
- with_fixed_indentation
IndentationWidth:
Layout/RedundantLineBreak:
Description: Do not break up an expression into multiple lines when it fits on a
single line.
Enabled: false
InspectBlocks: false
VersionAdded: '1.13'
Layout/RescueEnsureAlignment:
Description: Align rescues and ensures correctly.
Enabled: true
VersionAdded: '0.49'
Layout/SingleLineBlockChain:
Description: Put method call on a separate line if chained to a single line block.
Enabled: false
VersionAdded: '1.14'
Layout/SpaceAfterColon:
Description: Use spaces after colons.
StyleGuide: "#spaces-operators"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAfterComma:
Description: Use spaces after commas.
StyleGuide: "#spaces-operators"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAfterMethodName:
Description: Do not put a space between a method name and the opening parenthesis
in a method definition.
StyleGuide: "#parens-no-spaces"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAfterNot:
Description: Tracks redundant space after the ! operator.
StyleGuide: "#no-space-bang"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAfterSemicolon:
Description: Use spaces after semicolons.
StyleGuide: "#spaces-operators"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAroundBlockParameters:
Description: Checks the spacing inside and after block parameters pipes.
Enabled: true
VersionAdded: '0.49'
EnforcedStyleInsidePipes: no_space
SupportedStylesInsidePipes:
- space
- no_space
Layout/SpaceAroundEqualsInParameterDefault:
Description: Checks that the equals signs in parameter default assignments have
or don't have surrounding space depending on configuration.
StyleGuide: "#spaces-around-equals"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: space
SupportedStyles:
- space
- no_space
Layout/SpaceAroundKeyword:
Description: Use a space around keywords if appropriate.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceAroundMethodCallOperator:
Description: Checks method call operators to not have spaces around them.
Enabled: true
VersionAdded: '0.82'
Layout/SpaceAroundOperators:
Description: Use a single space around operators.
StyleGuide: "#spaces-operators"
Enabled: true
VersionAdded: '0.49'
AllowForAlignment: true
EnforcedStyleForExponentOperator: no_space
SupportedStylesForExponentOperator:
- space
- no_space
Layout/SpaceBeforeBlockBraces:
Description: Checks that the left block brace has or doesn't have space before it.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: space
SupportedStyles:
- space
- no_space
EnforcedStyleForEmptyBraces: space
SupportedStylesForEmptyBraces:
- space
- no_space
VersionChanged: '0.52'
Layout/SpaceBeforeBrackets:
Description: Checks for receiver with a space before the opening brackets.
StyleGuide: "#space-in-brackets-access"
Enabled: true
VersionAdded: '1.7'
Layout/SpaceBeforeComma:
Description: No spaces before commas.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceBeforeComment:
Description: Checks for missing space between code and a comment on the same line.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceBeforeFirstArg:
Description: Checks that exactly one space is used between a method name and the
first argument for method calls without parentheses.
Enabled: true
VersionAdded: '0.49'
AllowForAlignment: true
Layout/SpaceBeforeSemicolon:
Description: No spaces before semicolons.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceInLambdaLiteral:
Description: Checks for spaces in lambda literals.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: require_no_space
SupportedStyles:
- require_no_space
- require_space
Layout/SpaceInsideArrayLiteralBrackets:
Description: Checks the spacing inside array literal brackets.
Enabled: true
VersionAdded: '0.52'
EnforcedStyle: no_space
SupportedStyles:
- space
- no_space
- compact
EnforcedStyleForEmptyBrackets: no_space
SupportedStylesForEmptyBrackets:
- space
- no_space
Layout/SpaceInsideArrayPercentLiteral:
Description: No unnecessary additional spaces between elements in %i/%w literals.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceInsideBlockBraces:
Description: Checks that block braces have or don't have surrounding space. For
blocks taking parameters, checks that the left brace has or doesn't have trailing
space.
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: space
SupportedStyles:
- space
- no_space
EnforcedStyleForEmptyBraces: no_space
SupportedStylesForEmptyBraces:
- space
- no_space
SpaceBeforeBlockParameters: true
Layout/SpaceInsideHashLiteralBraces:
Description: Use spaces inside hash literal braces - or don't.
StyleGuide: "#spaces-braces"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: space
SupportedStyles:
- space
- no_space
- compact
EnforcedStyleForEmptyBraces: no_space
SupportedStylesForEmptyBraces:
- space
- no_space
Layout/SpaceInsideParens:
Description: No spaces after ( or before ).
StyleGuide: "#spaces-braces"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '1.22'
EnforcedStyle: no_space
SupportedStyles:
- space
- compact
- no_space
Layout/SpaceInsidePercentLiteralDelimiters:
Description: No unnecessary spaces inside delimiters of %i/%w/%x literals.
Enabled: true
VersionAdded: '0.49'
Layout/SpaceInsideRangeLiteral:
Description: No spaces inside range literals.
StyleGuide: "#no-space-inside-range-literals"
Enabled: true
VersionAdded: '0.49'
Layout/SpaceInsideReferenceBrackets:
Description: Checks the spacing inside referential brackets.
Enabled: true
VersionAdded: '0.52'
VersionChanged: '0.53'
EnforcedStyle: no_space
SupportedStyles:
- space
- no_space
EnforcedStyleForEmptyBrackets: no_space
SupportedStylesForEmptyBrackets:
- space
- no_space
Layout/SpaceInsideStringInterpolation:
Description: Checks for padding/surrounding spaces inside string interpolation.
StyleGuide: "#string-interpolation"
Enabled: true
VersionAdded: '0.49'
EnforcedStyle: no_space
SupportedStyles:
- space
- no_space
Layout/TrailingEmptyLines:
Description: Checks trailing blank lines and final newline.
StyleGuide: "#newline-eof"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '0.77'
EnforcedStyle: final_newline
SupportedStyles:
- final_newline
- final_blank_line
Layout/TrailingWhitespace:
Description: Avoid trailing whitespace.
StyleGuide: "#no-trailing-whitespace"
Enabled: true
VersionAdded: '0.49'
VersionChanged: '1.0'
AllowInHeredoc: false
Lint/AmbiguousAssignment:
Description: Checks for mistyped shorthand assignments.
Enabled: false
VersionAdded: '1.7'
Lint/AmbiguousBlockAssociation: