This repository has been archived by the owner on Nov 16, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
.rubocop_enabled.yml
759 lines (586 loc) · 19.4 KB
/
.rubocop_enabled.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
# These are all the cops that are enabled in the default configuration.
Layout/AccessModifierIndentation:
Description: Check indentation of private/protected visibility modifiers.
Enabled: true
Style/Alias:
Description: "Use alias_method instead of alias."
Enabled: true
Layout/AlignHash:
Description: >-
Align the elements of a hash literal if they span more than
one line.
Enabled: true
Layout/AlignParameters:
Description: >-
Align the parameters of a method call if they span more
than one line.
Enabled: true
Style/AndOr:
Description: "Use &&/|| instead of and/or."
Enabled: true
Style/ArrayJoin:
Description: "Use Array#join instead of Array#*."
Enabled: true
Style/AsciiComments:
Description: "Use only ascii symbols in comments."
Enabled: true
Naming/AsciiIdentifiers:
Description: "Use only ascii symbols in identifiers."
Enabled: true
Style/Attr:
Description: "Checks for uses of Module#attr."
Enabled: true
Style/BeginBlock:
Description: "Avoid the use of BEGIN blocks."
Enabled: true
Style/BlockComments:
Description: "Do not use block comments."
Enabled: true
Metrics/BlockNesting:
Description: "Avoid excessive block nesting"
Enabled: true
Style/BlockDelimiters:
Description: >-
Avoid using {...} for multi-line blocks (multiline chaining is
always ugly).
Prefer {...} over do...end for single-line blocks.
Enabled: true
Style/BracesAroundHashParameters:
Description: "Enforce braces style inside hash parameters."
Enabled: true
Style/CaseEquality:
Description: "Avoid explicit use of the case equality operator(===)."
Enabled: true
Layout/CaseIndentation:
Description: "Indentation of when in a case/when/[else/]end."
Enabled: true
Style/CharacterLiteral:
Description: "Checks for uses of character literals."
Enabled: true
Naming/ClassAndModuleCamelCase:
Description: "Use CamelCase for classes and modules."
Enabled: true
Style/ClassAndModuleChildren:
Description: "Checks style of children classes and modules."
Enabled: true
Style/ClassCheck:
Description: "Enforces consistent use of `Object#is_a?` or `Object#kind_of?`."
Enabled: true
Style/ClassMethods:
Description: "Use self when defining module/class methods."
Enabled: true
Style/ClassVars:
Description: "Avoid the use of class variables."
Enabled: true
Style/CollectionMethods:
Description: "Preferred collection methods."
Enabled: true
Style/ColonMethodCall:
Description: "Do not use :: for method call."
Enabled: true
Style/CommentAnnotation:
Description: >-
Checks formatting of special comments
(TODO, FIXME, OPTIMIZE, HACK, REVIEW).
Enabled: true
Layout/CommentIndentation:
Description: "Indentation of comments."
Enabled: true
Naming/ConstantName:
Description: "Constants should use SCREAMING_SNAKE_CASE."
Enabled: true
Style/DefWithParentheses:
Description: "Use def with parentheses when there are arguments."
Enabled: true
Style/PreferredHashMethods:
Description: "Checks for use of deprecated Hash methods."
Enabled: true
Style/Documentation:
Description: "Document classes and non-namespace modules."
Enabled: true
Layout/DotPosition:
Description: "Checks the position of the dot in multi-line method calls."
Enabled: true
Style/DoubleNegation:
Description: "Checks for uses of double negation (!!)."
Enabled: true
Style/EachWithObject:
Description: "Prefer `each_with_object` over `inject` or `reduce`."
Enabled: true
Layout/EmptyLineBetweenDefs:
Description: "Use empty lines between defs."
Enabled: true
Layout/EmptyLines:
Description: "Don't use several empty lines in a row."
Enabled: true
Layout/EmptyLinesAroundAccessModifier:
Description: "Keep blank lines around access modifiers."
Enabled: true
Layout/EmptyLinesAroundBlockBody:
Description: "Keeps track of empty lines around expression bodies."
Enabled: true
Layout/EmptyLinesAroundClassBody:
Description: "Keeps track of empty lines around expression classes."
Enabled: true
Layout/EmptyLinesAroundModuleBody:
Description: "Keeps track of empty lines around expression modules."
Enabled: true
Style/EmptyLiteral:
Description: "Prefer literals to Array.new/Hash.new/String.new."
Enabled: true
Style/Encoding:
Description: "Use UTF-8 as the source file encoding."
Enabled: true
Style/EndBlock:
Description: "Avoid the use of END blocks."
Enabled: true
Layout/EndOfLine:
Description: "Use Unix-style line endings."
Enabled: true
Style/EvenOdd:
Description: "Favor the use of Fixnum#even? && Fixnum#odd?"
Enabled: true
Naming/FileName:
Description: "Use snake_case for source file names."
Enabled: true
Style/FlipFlop:
Description: "Checks for flip flops"
Enabled: true
Style/For:
Description: "Checks use of for or each in multiline loops."
Enabled: true
Style/FormatString:
Description: "Enforce the use of Kernel#sprintf, Kernel#format or String#%."
Enabled: true
Style/GlobalVars:
Description: "Do not introduce global variables."
Enabled: true
Style/GuardClause:
Description: "Check for conditionals that can be replaced with guard clauses"
Enabled: true
Style/HashSyntax:
Description: >-
Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
{ :a => 1, :b => 2 }.
Enabled: true
Style/IfUnlessModifier:
Description: >-
Favor modifier if/unless usage when you have a
single-line body.
Enabled: true
Style/IfWithSemicolon:
Description: "Never use if x; .... Use the ternary operator instead."
Enabled: true
Layout/IndentationConsistency:
Description: "Keep indentation straight."
Enabled: true
Layout/IndentationWidth:
Description: "Use 2 spaces for indentation."
Enabled: true
Layout/IndentArray:
Description: >-
Checks the indentation of the first element in an array
literal.
Enabled: true
Layout/IndentHash:
Description: "Checks the indentation of the first key in a hash literal."
Enabled: true
Style/Lambda:
Description: "Use the new lambda literal syntax for single-line blocks."
Enabled: true
Style/LambdaCall:
Description: "Use lambda.call(...) instead of lambda.(...)."
Enabled: true
Layout/LeadingCommentSpace:
Description: "Comments should start with a space."
Enabled: true
Style/LineEndConcatenation:
Description: >-
Use \ instead of + or << to concatenate two string literals at
line end.
Enabled: true
Metrics/LineLength:
Description: "Limit lines to 80 characters."
Enabled: true
Style/MethodCallWithoutArgsParentheses:
Description: "Do not use parentheses for method calls with no arguments."
Enabled: true
Style/MethodDefParentheses:
Description: >-
Checks if the method definitions have or don"t have
parentheses.
Enabled: true
Naming/MethodName:
Description: "Use the configured style when naming methods."
Enabled: true
Style/ModuleFunction:
Description: "Checks for usage of `extend self` in modules."
Enabled: true
Style/MultilineBlockChain:
Description: "Avoid multi-line chains of blocks."
Enabled: true
Style/MultilineIfThen:
Description: "Never use then for multi-line if/unless."
Enabled: true
Style/MultilineTernaryOperator:
Description: >-
Avoid multi-line ?: (the ternary operator);
use if/unless instead.
Enabled: true
Style/NegatedIf:
Description: >-
Favor unless over if for negative conditions
(or control flow or).
Enabled: true
Style/NegatedWhile:
Description: "Favor until over while for negative conditions."
Enabled: true
Style/NestedTernaryOperator:
Description: "Use one expression per branch in a ternary operator."
Enabled: true
Style/Next:
Description: "Use `next` to skip iteration instead of a condition at the end."
Enabled: true
Style/NilComparison:
Description: "Prefer x.nil? to x == nil."
Enabled: true
Style/NonNilCheck:
Description: "Checks for redundant nil checks."
Enabled: true
Style/Not:
Description: "Use ! instead of not."
Enabled: true
Style/NumericLiterals:
Description: >-
Add underscores to large numeric literals to improve their
readability.
Enabled: true
Style/OneLineConditional:
Description: >-
Favor the ternary operator(?:) over
if/then/else/end constructs.
Enabled: true
Naming/BinaryOperatorParameterName:
Description: "When defining binary operators, name the argument other."
Enabled: true
Style/ParenthesesAroundCondition:
Description: >-
Don't use parentheses around the condition of an
if/unless/while.
Enabled: true
Style/PercentLiteralDelimiters:
Description: "Use `%`-literal delimiters consistently"
Enabled: true
Style/PerlBackrefs:
Description: "Avoid Perl-style regex back references."
Enabled: true
Naming/PredicateName:
Description: "Check the names of predicate methods."
Enabled: true
Style/Proc:
Description: "Use proc instead of Proc.new."
Enabled: true
Style/RaiseArgs:
Description: "Checks the arguments passed to raise/fail."
Enabled: true
Style/RedundantBegin:
Description: "Don't use begin blocks when they are not needed."
Enabled: true
Style/RedundantException:
Description: "Checks for an obsolete RuntimeException argument in raise/fail."
Enabled: true
Style/RedundantReturn:
Description: "Don't use return where it's not required."
Enabled: true
Style/RedundantSelf:
Description: "Don't use self where it's not needed."
Enabled: true
Style/RegexpLiteral:
Description: >-
Use %r for regular expressions matching more than
`MaxSlashes` '/' characters.
Use %r only for regular expressions matching more than
`MaxSlashes` '/' character.
Enabled: true
Style/RescueModifier:
Description: "Avoid using rescue in its modifier form."
Enabled: true
Style/SelfAssignment:
Description: "Checks for places where self-assignment shorthand should have been used."
Enabled: true
Style/Semicolon:
Description: "Don't use semicolons to terminate expressions."
Enabled: true
Style/SignalException:
Description: "Checks for proper usage of fail and raise."
Enabled: true
Style/SingleLineBlockParams:
Description: "Enforces the names of some block params."
Enabled: true
Style/SingleLineMethods:
Description: "Avoid single-line methods."
Enabled: true
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
Layout/SpaceAfterColon:
Description: "Use spaces after colons."
Enabled: true
Layout/SpaceAfterComma:
Description: "Use spaces after commas."
Enabled: true
Layout/SpaceAroundKeyword:
Description: "Use spaces after if/elsif/unless/while/until/case/when."
Enabled: true
Layout/SpaceAfterMethodName:
Description: >-
Never put a space between a method name and the opening
parenthesis in a method definition.
Enabled: true
Layout/SpaceAfterNot:
Description: Tracks redundant space after the ! operator.
Enabled: true
Layout/SpaceAfterSemicolon:
Description: "Use spaces after semicolons."
Enabled: true
Layout/SpaceBeforeBlockBraces:
Description: >-
Checks that the left block brace has or doesn't have space
before it.
Enabled: true
Layout/SpaceBeforeComma:
Description: "No spaces before commas."
Enabled: true
Layout/SpaceBeforeComment:
Description: >-
Checks for missing space between code and a comment on the
same line.
Enabled: true
Layout/SpaceBeforeSemicolon:
Description: "No spaces before semicolons."
Enabled: true
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
Layout/SpaceAroundEqualsInParameterDefault:
Description: >-
Checks that the equals signs in parameter default assignments
have or don't have surrounding space depending on
configuration.
Enabled: true
Layout/SpaceAroundOperators:
Description: "Use spaces around operators."
Enabled: true
Layout/SpaceAroundKeyword:
Description: "Put a space before the modifier keyword."
Enabled: true
Layout/SpaceInsideHashLiteralBraces:
Description: "Use spaces inside hash literal braces - or don't."
Enabled: true
Layout/SpaceInsideParens:
Description: "No spaces after ( or before )."
Enabled: true
Style/SpecialGlobalVars:
Description: "Avoid Perl-style global variables."
Enabled: true
Style/StringLiterals:
Description: "Checks if uses of quotes match the configured preference."
Enabled: true
Layout/Tab:
Description: "No hard tabs."
Enabled: true
Layout/TrailingBlankLines:
Description: "Checks trailing blank lines and final newline."
Enabled: true
Style/TrailingCommaInArguments:
Description: 'Checks for trailing comma in argument lists.'
StyleGuide: '#no-trailing-params-comma'
Enabled: true
Style/TrailingCommaInArrayLiteral:
Description: 'Checks for trailing comma in array literals.'
StyleGuide: '#no-trailing-array-commas'
Enabled: true
Style/TrailingCommaInHashLiteral:
Description: 'Checks for trailing comma in hash literals.'
Enabled: true
Layout/TrailingWhitespace:
Description: "Avoid trailing whitespace."
Enabled: true
Style/TrivialAccessors:
Description: "Prefer attr_* methods to trivial readers/writers."
Enabled: true
Style/UnlessElse:
Description: >-
Never use unless with else. Rewrite these with the positive
case first.
Enabled: true
Style/UnneededCapitalW:
Description: "Checks for %W when interpolation is not needed."
Enabled: true
Style/CommandLiteral:
Description: "Checks for %x when `` would do."
Enabled: true
Style/VariableInterpolation:
Description: >-
Don't interpolate global, instance and class variables
directly in strings.
Enabled: true
Naming/VariableName:
Description: "Use the configured style when naming variables."
Enabled: true
Style/WhenThen:
Description: "Use when x then ... for one-line cases."
Enabled: true
Style/WhileUntilDo:
Description: "Checks for redundant do after while or until."
Enabled: true
Style/WhileUntilModifier:
Description: >-
Favor modifier while/until usage when you have a
single-line body.
Enabled: true
Style/WordArray:
Description: "Use %w or %W for arrays of words."
Enabled: true
#################### Lint ################################
### Warnings
Lint/AmbiguousOperator:
Description: >-
Checks for ambiguous operators in the first argument of a
method invocation without parentheses.
Enabled: true
Lint/AmbiguousRegexpLiteral:
Description: >-
Checks for ambiguous regexp literals in the first argument of
a method invocation without parenthesis.
Enabled: true
Layout/BlockAlignment:
Description: "Align block ends correctly."
Enabled: true
Layout/ConditionPosition:
Description: "Checks for condition placed in a confusing position relative to the keyword."
Enabled: true
Lint/Debugger:
Description: "Check for debugger calls."
Enabled: true
Layout/DefEndAlignment:
Description: "Align ends corresponding to defs correctly."
Enabled: true
Lint/DeprecatedClassMethods:
Description: "Check for deprecated class method calls."
Enabled: true
Lint/ElseLayout:
Description: "Check for odd code arrangement in an else block."
Enabled: true
Lint/EmptyEnsure:
Description: "Checks for empty ensure block."
Enabled: true
Lint/EmptyInterpolation:
Description: "Checks for empty string interpolation."
Enabled: true
Layout/EndAlignment:
Description: "Align ends correctly."
Enabled: true
Lint/EndInMethod:
Description: "END blocks should not be placed inside method definitions."
Enabled: true
Lint/EnsureReturn:
Description: "Never use return in an ensure block."
Enabled: true
Security/Eval:
Description: "The use of eval represents a serious security risk."
Enabled: true
Lint/HandleExceptions:
Description: "Don't suppress exception."
Enabled: true
Lint/LiteralInInterpolation:
Description: "Checks for literals used in interpolation."
Enabled: true
Lint/Loop:
Description: >-
Use Kernel#loop with break rather than begin/end/until or
begin/end/while for post-loop tests.
Enabled: true
Lint/ParenthesesAsGroupedExpression:
Description: >-
Checks for method calls with a space before the opening
parenthesis.
Enabled: true
Lint/RequireParentheses:
Description: >-
Use parentheses in the method call to avoid confusion
about precedence.
Enabled: true
Lint/RescueException:
Description: "Avoid rescuing the Exception class."
Enabled: true
Lint/ShadowingOuterLocalVariable:
Description: >-
Do not use the same name as outer local variable
for block arguments or block local variables.
Enabled: true
Layout/SpaceBeforeFirstArg:
Description: >-
Put a space between a method name and the first argument
in a method call without parentheses.
Enabled: true
Lint/StringConversionInInterpolation:
Description: "Checks for Object#to_s usage in string interpolation."
Enabled: true
Lint/UnderscorePrefixedVariableName:
Description: "Do not use prefix `_` for a variable that is used."
Enabled: true
Lint/UnusedBlockArgument:
Description: "Checks for unused block arguments."
Enabled: true
Lint/UnusedMethodArgument:
Description: "Checks for unused method arguments."
Enabled: true
Lint/UnreachableCode:
Description: "Unreachable code."
Enabled: true
Lint/UselessAccessModifier:
Description: "Checks for useless access modifiers."
Enabled: true
Lint/UselessAssignment:
Description: "Checks for useless assignment to a local variable."
Enabled: true
Lint/UselessComparison:
Description: "Checks for comparison of something with itself."
Enabled: true
Lint/UselessElseWithoutRescue:
Description: "Checks for useless `else` in `begin..end` without `rescue`."
Enabled: true
Lint/UselessSetterCall:
Description: "Checks for useless setter call to a local variable."
Enabled: true
Lint/Void:
Description: "Possible use of operator/literal/variable in void context."
Enabled: true
##################### Rails ##################################
Rails/ActionFilter:
Description: "Enforces consistent use of action filter methods."
Enabled: true
Rails/Delegate:
Description: "Prefer delegate method for delegations."
Enabled: true
Rails/HasAndBelongsToMany:
Description: "Prefer has_many :through to has_and_belongs_to_many."
Enabled: true
Rails/Output:
Description: "Checks for calls to puts, print, etc."
Enabled: true
Rails/ReadWriteAttribute:
Description: "Checks for read_attribute(:attr) and write_attribute(:attr, val)."
Enabled: true
Rails/ScopeArgs:
Description: "Checks the arguments of ActiveRecord scopes."
Enabled: true
Rails/Validation:
Description: "Use sexy validations."
Enabled: true