-
Notifications
You must be signed in to change notification settings - Fork 4
/
.rubocop.yml
356 lines (311 loc) · 8.85 KB
/
.rubocop.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
inherit_from: .rubocop_todo.yml
require:
- rubocop-minitest
- rubocop-rake
AllCops:
DisplayCopNames: true
DisplayStyleGuide: true
ExtraDetails: true
TargetRubyVersion: 2.5
Exclude:
- 'bin/**/*'
- 'exe/**/*'
- 'fixtures/**/*'
- 'tmp/**/*'
- 'vendor/**/*'
################################################################################
# Enabling new cops:
Gemspec/DeprecatedAttributeAssignment: # new in 1.30
Enabled: true
Gemspec/RequireMFA: # new in 1.23
Enabled: true
Layout/LineContinuationLeadingSpace: # new in 1.31
Enabled: true
Layout/LineContinuationSpacing: # new in 1.31
Enabled: true
Lint/ConstantOverwrittenInRescue: # new in 1.31
Enabled: true
Lint/DuplicateMagicComment: # new in 1.37
Enabled: true
Lint/NonAtomicFileOperation: # new in 1.31
Enabled: true
Lint/RefinementImportMethods: # new in 1.27
Enabled: true
Lint/RequireRangeParentheses: # new in 1.32
Enabled: true
Lint/UselessRuby2Keywords: # new in 1.23
Enabled: true
Naming/BlockForwarding: # new in 1.24
Enabled: true
Security/CompoundHash: # new in 1.28
Enabled: true
Style/ArrayIntersect: # new in 1.40
Enabled: true
Style/EmptyHeredoc: # new in 1.32
Enabled: true
Style/EnvHome: # new in 1.29
Enabled: true
Style/FetchEnvVar: # new in 1.28
Enabled: true
Style/FileRead: # new in 1.24
Enabled: true
Style/FileWrite: # new in 1.24
Enabled: true
Style/MagicCommentFormat: # new in 1.35
Enabled: true
Style/MapCompactWithConditionalBlock: # new in 1.30
Enabled: true
Style/MapToHash: # new in 1.24
Enabled: true
Style/NestedFileDirname: # new in 1.26
Enabled: true
Style/ObjectThen: # new in 1.28
Enabled: true
Style/OpenStructUse: # new in 1.23
Enabled: true
Style/OperatorMethodCall: # new in 1.37
Enabled: true
Style/RedundantConstantBase: # new in 1.40
Enabled: true
Style/RedundantEach: # new in 1.38
Enabled: true
Style/RedundantInitialize: # new in 1.27
Enabled: true
Style/RedundantStringEscape: # new in 1.37
Enabled: true
Layout/LineEndStringConcatenationIndentation: # new in 1.18
Enabled: true
Layout/SpaceBeforeBrackets: # new in 1.7
Enabled: true
Lint/AmbiguousAssignment: # new in 1.7
Enabled: true
Lint/AmbiguousOperatorPrecedence: # new in 1.21
Enabled: true
Lint/AmbiguousRange: # new in 1.19
Enabled: true
Lint/DeprecatedConstants: # new in 1.8
Enabled: true
Lint/DuplicateBranch: # new in 1.3
Enabled: true
Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
Enabled: true
Lint/EmptyBlock: # new in 1.1
Enabled: true
Lint/EmptyClass: # new in 1.3
Enabled: true
Lint/EmptyInPattern: # new in 1.16
Enabled: true
Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
Enabled: true
Lint/LambdaWithoutLiteralBlock: # new in 1.8
Enabled: true
Lint/NoReturnInBeginEndBlocks: # new in 1.2
Enabled: true
Lint/NumberedParameterAssignment: # new in 1.9
Enabled: true
Lint/OrAssignmentToConstant: # new in 1.9
Enabled: true
Lint/RedundantDirGlobSort: # new in 1.8
Enabled: true
Lint/RequireRelativeSelfPath: # new in 1.22
Enabled: true
Lint/SymbolConversion: # new in 1.9
Enabled: true
Lint/ToEnumArguments: # new in 1.1
Enabled: true
Lint/TripleQuotes: # new in 1.9
Enabled: true
Lint/UnexpectedBlockArity: # new in 1.5
Enabled: true
Lint/UnmodifiedReduceAccumulator: # new in 1.1
Enabled: true
Security/IoMethods: # new in 1.22
Enabled: true
Style/ArgumentsForwarding: # new in 1.1
Enabled: true
Style/CollectionCompact: # new in 1.2
Enabled: true
Style/DocumentDynamicEvalDefinition: # new in 1.1
Enabled: true
Style/EndlessMethod: # new in 1.8
Enabled: true
Style/HashConversion: # new in 1.10
Enabled: true
Style/HashExcept: # new in 1.7
Enabled: true
Style/IfWithBooleanLiteralBranches: # new in 1.9
Enabled: true
Style/InPatternThen: # new in 1.16
Enabled: true
Style/MultilineInPatternThen: # new in 1.16
Enabled: true
Style/NegatedIfElseCondition: # new in 1.2
Enabled: true
Style/NilLambda: # new in 1.3
Enabled: true
Style/NumberedParameters: # new in 1.22
Enabled: true
Style/NumberedParametersLimit: # new in 1.22
Enabled: true
Style/QuotedSymbols: # new in 1.16
Enabled: true
Style/RedundantArgument: # new in 1.4
Enabled: true
Style/RedundantSelfAssignmentBranch: # new in 1.19
Enabled: true
Style/SelectByRegexp: # new in 1.22
Enabled: true
Style/StringChars: # new in 1.12
Enabled: true
Style/SwapValues: # new in 1.1
Enabled: true
Minitest/AssertionInLifecycleHook: # new in 0.10
Enabled: true
Minitest/AssertKindOf: # new in 0.10
Enabled: true
Minitest/AssertOutput: # new in 0.10
Enabled: true
Minitest/AssertPathExists: # new in 0.10
Enabled: true
Minitest/AssertSilent: # new in 0.10
Enabled: true
Minitest/LiteralAsActualArgument: # new in 0.10
Enabled: true
Minitest/RefuteInDelta: # new in 0.10
Enabled: true
Minitest/RefuteKindOf: # new in 0.10
Enabled: true
Minitest/RefutePathExists: # new in 0.10
Enabled: true
Minitest/TestMethodName: # new in 0.10
Enabled: true
Minitest/UnreachableAssertion: # new in 0.14
Enabled: true
Minitest/UnspecifiedException: # new in 0.10
Enabled: true
Minitest/AssertPredicate: # new in 0.18
Enabled: true
Minitest/AssertRaisesCompoundBody: # new in 0.21
Enabled: true
Minitest/AssertRaisesWithRegexpArgument: # new in 0.22
Enabled: true
Minitest/DuplicateTestRun: # new in 0.19
Enabled: true
Minitest/RefutePredicate: # new in 0.18
Enabled: true
Minitest/SkipEnsure: # new in 0.20
Enabled: true
Minitest/SkipWithoutReason: # new in 0.24
Enabled: true
################################################################################
# Overrides:
Layout/ArgumentAlignment:
EnforcedStyle: with_fixed_indentation
# IndentationWidth: 2
# It's ok to have more than one empty line to create a 'paragrapth'.
Layout/EmptyLines:
Enabled: false
# Extra space is fine.
Layout/EmptyLinesAroundClassBody:
Enabled: false
# Extra space is fine.
Layout/EmptyLinesAroundModuleBody:
Enabled: false
# Normally one line in between, but two allowed for "paragraphs".
Layout/EmptyLineBetweenDefs:
AllowAdjacentOneLineDefs: true
NumberOfEmptyLines: [1, 2]
# Rely on Git to normalize end of lines.
Layout/EndOfLine:
Enabled: false
# Add lines as needed.
Layout/EmptyLinesAroundBlockBody:
Enabled: false
Layout/LineLength:
Exclude:
- features/step_definitions/**/*
Layout/ParameterAlignment:
EnforcedStyle: with_fixed_indentation
Naming/RescuedExceptionsVariableName:
PreferredName: error
Metrics/AbcSize:
Enabled: false
Exclude:
- test/**/*
Metrics/ClassLength:
Exclude:
- test/**/*
# Too noisy.
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/MethodLength:
Exclude:
- test/**/*
# Too noisy.
Metrics/PerceivedComplexity:
Enabled: false
# Nah, sometimes easier to read with accessors having separate grouping.
Style/AccessorGrouping:
Enabled: false
# Prefer { ... } over do ... end except for control flow and
# method defintions. Unfortunatly, no cop configuration for this.
# https://github.com/chneukirchen/styleguide/blob/e60de37b478d3f892f6985a58d573016f33f0269/RUBY-STYLE#L63-L67
Style/BlockDelimiters:
EnforcedStyle: semantic
Enabled: false
# Generally prefer compact style to reduce indentation. But no hard rule.
Style/ClassAndModuleChildren:
EnforcedStyle: compact
Enabled: false
# This doesn't always read nicely.
Style/ConditionalAssignment:
Enabled: false
# Nah, it's ok.
Style/CommentedKeyword:
Enabled: false
# TODO(thomthom): Consider turning this back on.
Style/Documentation:
Enabled: false
# Conflict too often with Metric/LineLength.
# https://github.com/bbatsov/rubocop/issues/1332#issuecomment-277503854
Style/GuardClause:
Enabled: false
# In the context of the Thor DLS the rocket arrow => reads better.
Style/HashSyntax:
Exclude:
- app/commands/**/*
# Some times it reads clearer to not trail if/unless at the end.
Style/IfUnlessModifier:
Enabled: false
Style/ModuleFunction:
Enabled: false
Style/MultilineIfModifier:
Enabled: false
# Excluding some files that copies the Thor implementation.
# TODO: Investigate if Thor changed their implementation.
Style/OptionalBooleanParameter:
Exclude:
- lib/skippy/cli.rb
- lib/skippy/command.rb
# %w and %i etc isn't really intuitive unless you are really familiar with the
# syntax. %w seems used often enough. But [:symbol, :foo] reads clearer than
# %i(symbol foo).
Style/SymbolArray:
Enabled: False
# Add trailing comma so it's easy to duplicate/add lines.
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma
# Not testing computed values, but serialized values.
# Ignoring floating point tolerance is fine (and wanted) in this case.
Minitest/AssertInDelta:
Enabled: false
# Too many false positives.
Minitest/AssertWithExpectedArgument:
Enabled: false
Minitest/EmptyLineBeforeAssertionMethods:
Enabled: false
# No such thing as too many assertions.
Minitest/MultipleAssertions:
Enabled: false