-
Notifications
You must be signed in to change notification settings - Fork 0
/
.rubocop.yml
463 lines (372 loc) · 9.84 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
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
inherit_from:
- .rubocop_todo.yml
- .rubocop/todo.yml
require: rubocop-performance
AllCops:
TargetRubyVersion: 3.0
NewCops: disable
SuggestExtensions: false
Exclude:
- CHANGELOG.md
- CONDUCT.md
- CONTRIBUTING.md
- Gemfile/**/*
- Gemfile.lock
- Guardfile/**/*
- HACKING.md
- LICENSE/**/*
- README.md
- Rakefile/**/*
- '*'
- __*
- __*/**/*
- appveyor.yml
- benchmark/**/*
- benchmark-ips/**/*
- bin/**/*
- build/**/*
- config.ru
- coverage/**/*
- docs/**/*
- examples/**/*
- exe/**/*
# - lib/**/*
- lib/opal/source_map/vlq.rb
- node_modules/**/*
# - opal/**/*
- opal.gemspec
- pkg/**/*
- spec/**/*
# - stdlib/**/*
- tasks/**/*
- test/**/*
- tmp/**/*
- vendored-minitest/**/*
- vendor/**/* # present in travis
# Files thate were copied from MRI as is
- 'stdlib/benchmark.rb'
- 'stdlib/observer.rb'
- 'stdlib/open-uri.rb'
- 'stdlib/stringio.rb'
- 'stdlib/source_map/*.rb'
- 'stdlib/racc/parser.rb'
- 'stdlib/e2mmap.rb'
- 'stdlib/matrix.rb'
- 'stdlib/matrix/*.rb'
- 'stdlib/pp.rb'
- 'stdlib/prettyprint.rb'
- 'stdlib/optparse.rb'
- 'stdlib/optparse/*.rb'
- 'stdlib/tmpdir.rb'
- 'stdlib/tempfile.rb'
inherit_mode:
merge:
- Exclude
Naming/MethodName:
Exclude:
# Ruby has methods like Integer/Float/Array
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Layout/ClosingParenthesisIndentation:
Enabled: false
Layout/CommentIndentation:
# The following files use comments to show generated ruby code
Exclude:
- 'lib/opal/rewriters/binary_operator_assignment.rb'
- 'lib/opal/rewriters/logical_operator_assignment.rb'
- 'lib/opal/source_map/file.rb'
# We need to support older rubies
Layout/HeredocIndentation:
Enabled: false
Style/FrozenStringLiteralComment:
Exclude:
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Layout/EmptyLineAfterMagicComment:
Exclude:
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Style/GlobalVars:
Exclude:
- 'opal/corelib/kernel.rb'
- 'stdlib/nodejs/irb.rb'
- 'stdlib/console.rb'
- 'stdlib/native.rb'
- 'stdlib/await.rb'
Layout/ExtraSpacing:
Exclude:
# This files uses extra spaces to show an inheritance tree of error classes
- 'opal/corelib/error.rb'
Layout/FirstArrayElementIndentation:
EnforcedStyle: consistent
Layout/SpaceAroundOperators:
Exclude:
- 'opal/corelib/error.rb'
Lint/BooleanSymbol:
Exclude:
# There are AST nodes and rewriters with types :true and :false
- 'lib/opal/nodes/**/*.rb'
- 'lib/opal/rewriters/**/*.rb'
Lint/InheritException:
Exclude:
- 'lib/opal/builder.rb'
- 'lib/opal/errors.rb'
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Lint/LiteralAsCondition:
Exclude:
# Opal supports if `...js...`
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Lint/Loop:
Exclude:
# This is for optimization purposes mostly
- 'opal/corelib/io.rb'
# Allow the use of if/unless inside blocks
Style/Next:
Enabled: false
Lint/RescueException:
Exclude:
# That's what MRI does
- 'opal/corelib/enumerator.rb'
# Promises must care about all exceptions
- 'stdlib/promise.rb'
- 'opal/corelib/binding.rb'
Lint/RedundantStringCoercion:
Exclude:
# That's what MRI does
- 'opal/corelib/error.rb'
Lint/UnusedBlockArgument:
Exclude:
# Variable from Ruby can be accessed in JS, rubocop can't catch it (but JSHint can)
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Lint/UnusedMethodArgument:
Exclude:
# Variable from Ruby can be accessed in JS, rubocop can't catch it (but JSHint can)
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Lint/UselessAssignment:
Exclude:
# Variable from Ruby can be accessed in JS, rubocop can't catch it (but JSHint can)
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Metrics/AbcSize:
Enabled: false
Metrics/BlockLength:
Enabled: false
Metrics/BlockNesting:
Enabled: false
Metrics/ClassLength:
Enabled: false
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/ModuleLength:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Metrics/ParameterLists:
Exclude:
# Some Ruby methods take 10 arguments
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Naming/BinaryOperatorParameterName:
Exclude:
# Opal follows MRI argument namings
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Naming/PredicateName:
# Ruby has "has_key?" method
ForbiddenPrefixes:
- is_
- have_
Performance/FlatMap:
Exclude:
# That's actually a definition of Enumerable#flat_map
- 'opal/corelib/enumerable.rb'
Performance/RegexpMatch:
# This cop converts =~ to match?
# But this method was introduced only in 2.4
Enabled: false
Performance/UnfreezeString:
Enabled: false
Style/AsciiComments:
Enabled: false
Style/CaseEquality:
Exclude:
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
- 'lib/opal/config.rb'
Style/ClassAndModuleChildren:
Enabled: false
Style/ClassVars:
Exclude:
# These classes use class variables on purpose
- 'lib/opal/rewriters/binary_operator_assignment.rb'
- 'lib/opal/rewriters/logical_operator_assignment.rb'
Style/CommandLiteral:
# This cop converts `` to %x{}
Enabled: false
Style/Documentation:
Enabled: false
Style/EmptyMethod:
# There are a lot of empty methods that are required to make MSpec working
Exclude:
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Style/IfUnlessModifier:
Enabled: false
Style/InfiniteLoop:
# while true is faster than loop
Enabled: false
Style/InverseMethods:
# That's what MRI does
Exclude:
- 'opal/corelib/basic_object.rb'
- 'opal/corelib/kernel.rb'
Lint/MissingSuper:
# Base Opal classes simply can't or shouldn't call super for #method_missing
Exclude:
- 'opal/corelib/basic_object.rb'
- 'opal/corelib/kernel.rb'
- 'opal/corelib/string/inheritance.rb'
- 'stdlib/native.rb'
- 'stdlib/delegate.rb'
- 'stdlib/ostruct.rb'
Style/MissingRespondToMissing:
Enabled: true
Style/NumericPredicate:
Enabled: false
Style/ParallelAssignment:
Enabled: false
Style/PercentLiteralDelimiters:
PreferredDelimiters:
default: '{}'
Exclude:
# Opal has a convention of %x{}
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Style/SafeNavigation:
# Opal supports old versions of Ruby that don't have safe navigator
Enabled: false
Style/SpecialGlobalVars:
Enabled: false
Style/StderrPuts:
Enabled: false
Style/YodaCondition:
Exclude:
# In Opal there are lot of cases like
# if `..js..` == object
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Layout/MultilineAssignmentLayout:
EnforcedStyle: same_line
Style/TrailingCommaInArguments:
# Any style is allowed
Enabled: false
Layout/ParameterAlignment:
EnforcedStyle: with_fixed_indentation
Layout/MultilineMethodCallBraceLayout:
EnforcedStyle: new_line
Style/Lambda:
EnforcedStyle: literal
Layout/EmptyLines:
# Empty lines can be used to separate interface and implementation
Enabled: false
Style/EmptyElse:
# Empty 'else' can be used to indicate a potential empty branch condition
EnforcedStyle: nil
Lint/EmptyWhen:
# Empty 'when' can be used to indicate a potential empty branch condition
Enabled: false
Style/StringLiterals:
Exclude:
# Nodes are more like DSL, so they are allowed to have any internal rules
# that make the code more readable
- 'lib/opal/nodes/**/*.rb'
Style/TrailingUnderscoreVariable:
# We treat a, = *b construction as a potential source of bugs
Enabled: false
Style/WhileUntilModifier:
Enabled: false
Style/RegexpLiteral:
# Use the style that you like more, but if there are slashes or backslashe
# prefer %r{} syntax.
# Rubocop doesn't check for backslashes, so this rule is disabled.
Enabled: false
Naming/FileName:
Exclude:
- 'stdlib/opal-builder.rb'
- 'stdlib/nodejs/open-uri.rb'
- 'stdlib/opal-parser.rb'
- 'stdlib/opal-platform.rb'
- 'stdlib/opal-source-maps.rb'
- 'stdlib/opal-replutils.rb'
Naming/ConstantName:
Exclude:
# MRI has a constant BigDecimal::SIGN_NaN
- 'stdlib/bigdecimal.rb'
- 'stdlib/opal-platform.rb'
Security/Eval:
Exclude:
# That's what parser does
- 'stdlib/opal-parser.rb'
Naming/AccessorMethodName:
Exclude:
# StringScanner has method 'get_byte'
- 'stdlib/strscan.rb'
# Exception has method 'set_backtrace'
- 'opal/corelib/error.rb'
Style/RescueStandardError:
Enabled: false
Style/TrailingCommaInArrayLiteral:
# Any style is allowed
Enabled: false
Style/TrailingCommaInHashLiteral:
# Any style is allowed
Enabled: false
Style/VariableInterpolation:
# `#@native.abc` makes sense for Opal
Enabled: false
Naming/MethodParameterName:
Exclude:
# This file uses parser's code that doesn't match our styling requirements
- 'lib/opal/parser/patch.rb'
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Lint/BigDecimalNew:
Exclude:
# That's the implementation of the Kernel#BigDecimal
- 'stdlib/bigdecimal/kernel.rb'
Style/MutableConstant:
Exclude:
- 'opal/**/*.rb'
- 'stdlib/**/*.rb'
Style/EmptyCaseCondition:
Enabled: false
# Use whatever suites the situation, sometimes assign_inside_condition is
# more readable over assign_to_condition despite the risk of repeating the
# variable name.
Style/ConditionalAssignment:
Enabled: false
Naming/MemoizedInstanceVariableName:
Exclude:
- lib/opal/parser/patch.rb # it's a monkey-patch on the parser gem
- lib/opal/nodes/rescue.rb # we know what we are doing here and no, it's not memoization
Style/AccessModifierDeclarations:
Enabled: false
Style/MultipleComparison:
Enabled: false
Layout/EmptyLineAfterGuardClause:
Enabled: false
Layout/HashAlignment:
Enabled: false
# No way to set multiple preferred names
Naming/RescuedExceptionsVariableName:
Enabled: false
Style/Semicolon:
AllowAsExpressionSeparator: true
Layout/EmptyLinesAroundExceptionHandlingKeywords:
Enabled: false