-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
.rubocop.yml
347 lines (256 loc) · 7.01 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
inherit_from: .rubocop_todo.yml
# Relaxed.Ruby.Style
require:
- rubocop-performance
- rubocop-rails
AllCops:
Exclude:
- "**/{tmp,vendor,spec/dummy,sandbox,templates,pkg}/**/*"
TargetRubyVersion: 3.1
NewCops: disable
SuggestExtensions: false
# We use class vars and will have to continue doing so for compatability
Style/ClassVars:
Enabled: false
# We need these names for backwards compatability
Naming/PredicateName:
Enabled: false
# We want to name rescued errors as error not simply e.
Naming/RescuedExceptionsVariableName:
Enabled: false
Naming/AccessorMethodName:
Enabled: false
# This has been used for customization
Style/MutableConstant:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
Style/EmptyElse:
Enabled: false
Style/GuardClause:
Enabled: false
Style/Next:
Enabled: false
Style/NumericPredicate:
Enabled: false
Style/WordArray:
Enabled: false
Style/ConditionalAssignment:
Enabled: false
Performance/Count:
Enabled: false
Style/RaiseArgs:
Enabled: false
Naming/BinaryOperatorParameterName:
Enabled: false
# We can use good judgement here
Style/RegexpLiteral:
Enabled: false
# Unicode comments are useful
Style/AsciiComments:
Enabled: false
Layout/LineLength:
Enabled: false
Layout/EndAlignment:
Enabled: false
Layout/ElseAlignment:
Enabled: false
Layout/IndentationWidth:
Enabled: false
Layout/ParameterAlignment:
Enabled: false
Layout/ClosingParenthesisIndentation:
Enabled: false
Layout/MultilineMethodCallIndentation:
Enabled: false
Layout/FirstArrayElementIndentation:
Enabled: false
Layout/FirstHashElementIndentation:
Enabled: false
Layout/HashAlignment:
Enabled: false
Style/TrailingCommaInArguments:
Enabled: false
Style/TrailingCommaInArrayLiteral:
Enabled: false
Style/TrailingCommaInHashLiteral:
Enabled: false
# Symbol Arrays are ok and the %i syntax widely unknown
Style/SymbolArray:
Enabled: false
Rails/DynamicFindBy:
Whitelist:
- find_by_param
- find_by_param!
# It's okay to skip model validations to setup a spec.
Rails/SkipsModelValidations:
Exclude:
- "*/spec/**/*"
# We use a lot of
#
# expect {
# something
# }.to { happen }
#
# syntax in the specs files.
Lint/AmbiguousBlockAssociation:
Exclude:
- "*/spec/**/*"
- "spec/**/*" # For the benefit of apps that inherit from this config
# We use eval to add common_spree_dependencies into the Gemfiles of each of our gems
Security/Eval:
Exclude:
- "Gemfile"
- "common_spree_dependencies.rb"
- "*/Gemfile"
Naming/VariableNumber:
Enabled: false
# Write empty methods as you wish.
Style/EmptyMethod:
Enabled: false
# From http://relaxed.ruby.style/
Style/Alias:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylealias
Style/BeginBlock:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylebeginblock
Style/BlockDelimiters:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
Style/Documentation:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styledocumentation
Layout/DotPosition:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styledotposition
Style/DoubleNegation:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styledoublenegation
Style/EndBlock:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleendblock
Style/FormatString:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleformatstring
Style/IfUnlessModifier:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
Style/Lambda:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylelambda
Style/ModuleFunction:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
Style/MultilineBlockChain:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
Style/NegatedIf:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylenegatedif
Style/NegatedWhile:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
Style/ParallelAssignment:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
Style/PercentLiteralDelimiters:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
Style/PerlBackrefs:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
Style/Semicolon:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylesemicolon
Style/SignalException:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylesignalexception
Style/SingleLineBlockParams:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
Style/SingleLineMethods:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
Layout/SpaceBeforeBlockBraces:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
Layout/SpaceInsideParens:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
Style/SpecialGlobalVars:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
Style/StringLiterals:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylestringliterals
Style/SymbolProc:
Enabled: false
Style/TernaryParentheses:
Enabled: false
Style/WhileUntilModifier:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
Lint/AmbiguousRegexpLiteral:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
Lint/AssignmentInCondition:
Enabled: false
StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
Metrics/AbcSize:
Enabled: false
Metrics/BlockNesting:
Enabled: false
Metrics/ClassLength:
Enabled: false
Metrics/ModuleLength:
Enabled: false
Metrics/BlockLength:
Enabled: false
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/ParameterLists:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Bundler/OrderedGems:
Enabled: false
Style/NumericLiterals:
Enabled: false
Style/FrozenStringLiteralComment:
Enabled: true
EnforcedStyle: always
Exclude:
- "*/lib/generators/**/*"
- "**/bin/**/*"
- "*/db/migrate/**/*"
- "*/config/importmap.rb"
# json.() is idiomatic in jbuilder files
Style/LambdaCall:
Enabled: false
Naming/MethodParameterName:
AllowedNames:
- id
- to
- _
# Rubocop doesn't understand side-effects
Style/IdenticalConditionalBranches:
Enabled: false
Naming/MemoizedInstanceVariableName:
Enabled: false
Lint/SuppressedException:
Enabled: false
Lint/MissingSuper:
Exclude:
- "*/app/components/**/*" # components need pristine initializer methods
- "core/lib/spree/deprecated_instance_variable_proxy.rb" # this is a known class that doesn't require super
- "core/lib/spree/preferences/configuration.rb" # this class has no superclass defining `self.inherited`
Rails/FindEach:
Exclude:
- "db/migrate/**/*"
# Since we're writing library code we can't assume that
# tasks should load the rails environment loaded.
Rails/RakeEnvironment:
Enabled: false