forked from instructure/canvas-lms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.rubocop.yml
501 lines (471 loc) · 13.1 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
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
require:
- rubocop-factory_bot
- rubocop-graphql
- rubocop-rails
- rubocop-rake
# this odd relative path is so that rubocop works when run without "bundle
# exec", such as from most editors/IDEs.
- ./gems/rubocop-canvas/lib/rubocop_canvas
- outrigger/cops/migration/tagged
inherit_gem:
rubocop-inst:
- rubocop.yml
- rubocop-rspec.yml
AllCops:
TargetRubyVersion: 3.1
Bundler:
Severity: error
Capybara:
Enabled: false # we don't use capybara (it's automatically included by rubocop-rspec until they hit 3.0)
Gemspec:
Severity: error
Gemspec/RequireMFA:
Enabled: false # gems hosted in this repo aren't meant to be published separately
Gemspec/RequiredRubyVersion:
# all the gemspecs in this repo are non-published gems
# the root Gemfile enforces the Ruby version, and we purposely
# don't specify required_ruby_version in the rest to reduce
# maintenance pain when updating ruby versions
Enabled: false
GraphQL/ArgumentDescription:
Enabled: false
GraphQL/FieldDescription:
Enabled: false
GraphQL/FieldDefinitions:
Enabled: false # we group field definitions with their implementation method
GraphQL/ObjectDescription:
Enabled: false
GraphQL/ResolverMethodLength:
Enabled: false # this is a Metrics-style cop
Layout:
Severity: error
Lint:
Severity: error
Lint/AmbiguousBlockAssociation:
AllowedMethods:
- change
- not_change
- raise_error
Lint/NoFileUtilsRmRf:
Severity: warning # intended for specs; not enforced
Lint/NoSleep:
Severity: warning # intended for specs; not enforced
Lint/NonLocalExitFromIterator:
Enabled: false # SnR is too low because of how often this construct is used
Lint/RedundantCopDisableDirective:
Enabled: false # can't have this enabled until https://github.com/rubocop/rubocop/issues/10263
Lint/SafeNavigationConsistency:
Enabled: false # https://github.com/rubocop/rubocop/issues/9816
Migration/Tagged:
AllowedTags:
- predeploy
- postdeploy
- cassandra
- dynamodb
Naming:
Severity: error
Naming/FileName:
Exclude:
- "**/Gemfile.d/~after.rb"
- "**/urn_*.rb"
- "**/fixtures/**/*.rb"
- "config/locales/*.rb" # names must match locale names
- "spec/selenium/a11y_and_i18n/localized-timezone-lists_spec.rb" # matches JS file it tests
Performance:
Severity: error
Performance/CollectionLiteralInLoop:
Severity: convention # not auto-correctable; can be a pain to fix and isn't necessarily performance critical
Performance/MethodObjectAsBlock:
Enabled: false # decreases expressiveness
Rails:
Severity: error
Exclude:
- "bin/**/*"
Rails/ApplicationRecord:
Enabled: false # we never bothered creating an ApplicationRecord
Rails/Blank:
UnlessPresent: false # allow `unless foo.present?`
Rails/ContentTag:
Exclude:
- "**/db/migrate/*" # this cop is for views, not migrations, where it gets confused with outrigger
- "doc/**/*"
Rails/DefaultScope:
Enabled: true
Rails/DynamicFindBy:
AllowedMethods:
- find_by_confirmation_code # CommunicationChannel
- find_by_signature # AssetSignature
- find_by_domain # Account
- find_by_name # PluginSetting
- find_by_asset_string # ApplicationRecord
- find_by_pseudonym_credentials # SessionPersistenceToken
- find_by_quiz # Quizzes::OutstandingQuizSubmissionManager
Rails/HasManyOrHasOneDependent:
Enabled: false # legacy code + most things we soft delete anyway
Rails/HelperInstanceVariable:
Enabled: false # legacy code
Rails/I18nLocaleTexts:
Exclude:
- spec/**/*.rb
- "**/spec_canvas/**/*.rb"
Rails/NegateInclude:
Enabled: false # exclude? isn't as intuitive as !include?
Rails/Present:
UnlessBlank: false # allow `unless foo.blank?`
Rails/RedundantPresenceValidationOnBelongsTo:
Enabled: false # we do _not_ have config.active_record.belongs_to_required_by_default set
# even though it's been a default since Rails 5.0, we don't have a
# config.load_defaults line
Rails/SkipsModelValidations:
Enabled: false # Canvas skips validations in many places for optimization reasons
Rails/WhereExists:
EnforcedStyle: where
Rails/WhereNotWithMultipleConditions:
Enabled: false # We're firmly on Rails 6.1+; no need to worry about legacy behavior
RSpec:
Severity: error
RSpec/AnyInstance:
Enabled: false # while using an instance double would be preferable, it's a pain
RSpec/IndexedLet:
Enabled: false
RSpec/InstanceVariable:
Enabled: false # legacy code
RSpec/MultipleMemoizedHelpers:
Enabled: false # complicated setup is sometimes necessary
RSpec/SubjectStub:
Enabled: false # yes, canvas is big and complicated sometimes
RSpec/Capybara:
Enabled: false # we don't use capybara
RSpec/Rails:
Severity: error
Security:
Severity: error
Security/YAMLLoad:
# technically even YAML.load is fairly safe in Canvas because we override it and only allow certain types
# but still avoid it if you can.
Severity: warning
AutoCorrect: false
Specs/EnsureSpecExtension:
Exclude:
- spec/shared_examples/**/*
Style:
Severity: error
Style/BlockDelimiters:
AllowedMethods: []
Style/Documentation:
Enabled: false # most things don't need to be documented
Style/DoubleNegation:
Enabled: false # we use double negation, even outside of return context, to get an actual true/false for various API results
Style/FetchEnvVar:
Enabled: false # ENV vars are generally all optional, and it's expected to return nil
Style/FloatDivision:
Enabled: false # inherently dangerous cop because the args may not even be integers, and only upside is maybe saving 4 characters
Style/FormatStringToken:
Enabled: false # I18n requires template style, but ohter code uses annotated style, and there are some trivial unannotted that don't really need to be annotated
Style/HashLikeCase:
Enabled: false
Style/IfUnlessModifier:
# see also https://github.com/rubocop/rubocop/discussions/10048
Enabled: false # can obscure important decisions or put too much code in a line
Style/MultilineBlockChain:
Enabled: false # this is common when building up a large API result
Style/NumericPredicate:
Enabled: false # `> 0` can be easier to read than `.positive?`
Style/OpenStructUse:
Severity: warning # unfortunately, legacy code uses it a lot;
Style/ParallelAssignment:
Enabled: false # most uses are legitimate deconstruction or value swapping
Style/ReturnNil:
Enabled: false # explicit nil is okay when a method is expected to have a return value
Style/SoleNestedConditional:
AllowModifier: true # it makes lines too long and complicated otherwise
Style/SpecialGlobalVars:
Enabled: false # $! and $? are fine
Style/SymbolArray:
MinSize: 3
Style/WhileUntilModifier:
Enabled: false # nontrivial loops should look like loops
Style/WordArray:
MinSize: 3
# the following cops have offenses in the code base that have not been fixed.
# we should eventually either fix them, or turn them off completely (and move
# them to the section above)
# auto-correct needs to be disabled for any that support it in the meantime
FactoryBot/ConsistentParenthesesStyle:
AutoCorrect: false
FactoryBot/CreateList:
AutoCorrect: false
FactoryBot/SyntaxMethods:
AutoCorrect: false
GraphQL/FieldMethod:
AutoCorrect: false
GraphQL/FieldName:
AutoCorrect: false
GraphQL/MultipleFieldDefinitions:
AutoCorrect: false
GraphQL/OrderedArguments:
AutoCorrect: false
GraphQL/OrderedFields:
AutoCorrect: false
GraphQL/UnusedArgument:
AutoCorrect: false
Layout/LineLength:
Enabled: false
AutoCorrect: false
Lint/UriEscapeUnescape:
Severity: warning
Naming/AccessorMethodName:
Severity: convention
Naming/BinaryOperatorParameterName:
Severity: convention
AutoCorrect: false
Naming/BlockParameterName:
Severity: convention
Naming/ClassAndModuleCamelCase:
Severity: convention
Naming/ConstantName:
Severity: convention
Naming/MemoizedInstanceVariableName:
EnforcedStyleForLeadingUnderscores: optional
Severity: convention
AutoCorrect: false
Naming/MethodName:
Severity: convention
Naming/MethodParameterName:
Severity: convention
Naming/PredicateName:
Severity: convention
Naming/VariableName:
Severity: convention
Naming/VariableNumber:
Enabled: false
Rails/ActionControllerFlashBeforeRender:
Severity: convention
AutoCorrect: false
Rails/ActionOrder:
Severity: convention
AutoCorrect: false
Rails/ActiveRecordCallbacksOrder:
Severity: convention
AutoCorrect: false
Rails/ActiveRecordOverride:
Severity: convention
Rails/ActiveSupportOnLoad:
Severity: convention
AutoCorrect: false
Rails/ApplicationMailer:
Severity: convention
AutoCorrect: false
Rails/BelongsTo:
Severity: convention
AutoCorrect: false
Rails/BulkChangeTable:
Severity: convention
Rails/CreateTableWithTimestamps:
Severity: convention
Rails/Date:
Enabled: false
AutoCorrect: false
Rails/DeprecatedActiveModelErrorsMethods:
AutoCorrect: false
Rails/DuplicateAssociation:
AutoCorrect: false
Rails/EagerEvaluationLogMessage:
Severity: convention
AutoCorrect: false
Rails/EnumHash:
Severity: convention
AutoCorrect: false
Rails/FindBy:
Severity: convention
AutoCorrect: false
Rails/FindById:
Severity: convention
AutoCorrect: false
Rails/FindEach:
Severity: convention
AutoCorrect: false
Rails/InverseOf:
Severity: convention
Rails/LexicallyScopedActionFilter:
Severity: convention
Rails/NotNullColumn:
Severity: convention
Rails/Output:
Severity: convention
AutoCorrect: false
Rails/OutputSafety:
Severity: convention
Rails/Pick:
Severity: convention
AutoCorrect: false
Rails/PluckInWhere:
Severity: convention
AutoCorrect: false
Rails/RakeEnvironment:
Severity: convention
AutoCorrect: false
Rails/ReadWriteAttribute:
Enabled: false # accessors are often defined in terms of read_attribute
AutoCorrect: false
Rails/ReversibleMigration:
Severity: convention
Rails/TimeZone:
Enabled: false
AutoCorrect: false
Rails/TimeZoneAssignment:
Severity: convention
Rake/Desc:
Severity: convention
AutoCorrect: false
Rake/MethodDefinitionInTask:
Severity: convention
RSpec/AroundBlock:
Severity: convention
RSpec/Be:
Severity: convention
RSpec/BeforeAfterAll:
Severity: convention
RSpec/ContextMethod:
Severity: convention
AutoCorrect: false
RSpec/ContextWording:
Enabled: false
RSpec/DescribeClass:
Enabled: false
RSpec/DescribeMethod:
Severity: convention
RSpec/ExpectActual:
Severity: convention
AutoCorrect: false
RSpec/ExpectChange:
Enabled: false
AutoCorrect: false
RSpec/FilePath:
Severity: convention
RSpec/HooksBeforeExamples:
Severity: convention
AutoCorrect: false
RSpec/IdenticalEqualityAssertion:
Severity: convention
RSpec/ImplicitBlockExpectation:
Severity: convention
RSpec/ImplicitExpect:
Severity: convention
AutoCorrect: false
RSpec/IteratedExpectation:
Severity: convention
RSpec/LeakyConstantDeclaration:
Severity: convention
RSpec/LetSetup:
Severity: convention
RSpec/MessageChain:
Severity: convention
RSpec/MissingExampleGroupArgument:
Severity: convention
RSpec/MultipleDescribes:
Severity: convention
RSpec/NamedSubject:
Enabled: false
RSpec/NotToNot:
Enabled: false
AutoCorrect: false
RSpec/OverwritingSetup:
Severity: convention
RSpec/PendingWithoutReason:
Severity: convention
RSpec/PredicateMatcher:
Enabled: false
AutoCorrect: false
RSpec/ReceiveCounts:
Severity: convention
AutoCorrect: false
RSpec/ReturnFromStub:
Severity: convention
AutoCorrect: false
RSpec/ScatteredLet:
Severity: convention
AutoCorrect: false
RSpec/ScatteredSetup:
Enabled: false
RSpec/SharedContext:
Severity: convention
AutoCorrect: false
RSpec/SubjectDeclaration:
Severity: convention
RSpec/VariableName:
Severity: convention
RSpec/VerifiedDoubleReference:
Enabled: false
RSpec/VerifiedDoubles:
Enabled: false
Style/AccessModifierDeclarations:
Severity: convention
Style/AccessorGrouping:
Severity: convention
AutoCorrect: false
Style/CaseLikeIf:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
AutoCorrect: false
Style/ClassVars:
Severity: convention
Style/CombinableLoops:
Severity: convention
AutoCorrect: false
Style/CommentedKeyword:
Severity: convention
AutoCorrect: false
Style/DocumentDynamicEvalDefinition:
Severity: convention
Style/ExponentialNotation:
Severity: convention
Style/FormatString:
Severity: convention
AutoCorrect: false
Style/GlobalVars:
Severity: convention
Style/GuardClause:
Enabled: false
Style/HashAsLastArrayItem:
Severity: convention
AutoCorrect: false
Style/InfiniteLoop:
Severity: convention
AutoCorrect: false
Style/KeywordParametersOrder:
Severity: convention
AutoCorrect: false
Style/MissingRespondToMissing:
Severity: convention
Style/MixinUsage:
Severity: convention
Style/ModuleFunction:
Severity: convention
AutoCorrect: false
Style/MultipleComparison:
Severity: convention
AutoCorrect: false
Style/OptionalArguments:
Severity: convention
Style/OptionalBooleanParameter:
Severity: convention
Style/RescueModifier:
Severity: warning
AutoCorrect: false
Style/StringConcatenation:
Enabled: false
AutoCorrect: false
Style/TrailingCommaInArrayLiteral:
Enabled: false
AutoCorrect: false
Style/TrailingCommaInHashLiteral:
Enabled: false
AutoCorrect: false
Style/TrailingUnderscoreVariable:
Severity: convention
AutoCorrect: false
Style/WhileUntilDo:
Severity: convention
AutoCorrect: false