Read about our upcoming Code of Conduct on this issue

.rubocop.yml 7.37 KB
Newer Older
Rémy Coutable's avatar
Rémy Coutable committed
1
2
3
inherit_gem:
  gitlab-styles:
    - rubocop-default.yml
Robert Speicher's avatar
Robert Speicher committed
4

Z.J. van de Weg's avatar
Z.J. van de Weg committed
5
inherit_from: .rubocop_todo.yml
6
7
8
require:
  - ./rubocop/rubocop
  - rubocop-rspec
Z.J. van de Weg's avatar
Z.J. van de Weg committed
9

10
11
12
13
inherit_mode:
  merge:
    - Include

14
AllCops:
15
  TargetRubyVersion: 2.6
blackst0ne's avatar
blackst0ne committed
16
  TargetRailsVersion: 5.0
17
18
  Exclude:
    - 'vendor/**/*'
Mike Greiling's avatar
Mike Greiling committed
19
    - 'node_modules/**/*'
Sean McGivern's avatar
Sean McGivern committed
20
    - 'db/fixtures/**/*'
21
22
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
23
24
    - 'tmp/**/*'
    - 'bin/**/*'
25
    - 'generator_templates/**/*'
26
    - 'builds/**/*'
27
    - 'plugins/**/*'
28
    - 'file_hooks/**/*'
Lin Jen-Shin's avatar
Lin Jen-Shin committed
29
  CacheRootDirectory: tmp
30

31
32
33
34
35
36
Cop/StaticTranslationDefinition:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

37
38
39
40
41
42
43
44
45
46
47
# This cop checks whether some constant value isn't a
# mutable literal (e.g. array or hash).
Style/MutableConstant:
  Enabled: true
  Exclude:
    - 'db/migrate/**/*'
    - 'db/post_migrate/**/*'
    - 'ee/db/migrate/**/*'
    - 'ee/db/post_migrate/**/*'
    - 'ee/db/geo/migrate/**/*'

48
49
50
51
# TODO: Move this to gitlab-styles
Style/SafeNavigation:
  Enabled: false

gfyoung's avatar
gfyoung committed
52
53
54
55
56
57
58
59
60
61
62
63
# Frozen String Literal
Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - 'config.ru'
    - 'Dangerfile'
    - 'Gemfile'
    - 'Rakefile'
    - 'app/views/**/*'
    - 'config/**/*'
    - 'danger/**/*'
    - 'db/**/*'
Robert Speicher's avatar
Robert Speicher committed
64
65
    - 'ee/db/**/*'
    - 'ee/lib/tasks/**/*'
66
    - 'lib/tasks/**/*'
gfyoung's avatar
gfyoung committed
67
68
69
70
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'

71
72
73
RSpec/FilePath:
  Exclude:
    - 'qa/**/*'
74
75
    - 'spec/frontend/fixtures/*'
    - 'ee/spec/frontend/fixtures/*'
76
77
    - 'spec/requests/api/v3/*'

78
79
80
Naming/FileName:
  ExpectMatchingDefinition: true
  Exclude:
81
82
    - 'db/**/*'
    - 'ee/db/**/*'
83
84
85
86
87
88
    - 'spec/**/*'
    - 'features/**/*'
    - 'ee/spec/**/*'
    - 'qa/spec/**/*'
    - 'qa/qa/specs/**/*'
    - 'qa/bin/*'
89
    - 'ee/bin/*'
90
    - 'config/**/*'
91
    - 'ee/config/**/*'
92
    - 'lib/generators/**/*'
Mark Chao's avatar
Mark Chao committed
93
94
    - 'locale/unfound_translations.rb'
    - 'ee/locale/unfound_translations.rb'
95
    - 'ee/lib/generators/**/*'
Sanad Liaquat's avatar
Sanad Liaquat committed
96
97
    - 'qa/qa/scenario/test/integration/ldap_no_tls.rb'
    - 'qa/qa/scenario/test/integration/ldap_tls.rb'
Sanad Liaquat's avatar
Sanad Liaquat committed
98

99
100
101
102
103
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
Sanad Liaquat's avatar
Sanad Liaquat committed
104
    - SAML
Robert Speicher's avatar
Robert Speicher committed
105
    - SSO
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
    - IO
    - HMAC
    - QA
    - ENV
    - STL
    - PDF
    - SVG
    - CTE
    - DN
    - RSA
    - CI
    - CD
    - OAuth
    # default ones:
    - CLI
    - DSL
    - ACL
    - API
    - ASCII
    - CPU
    - CSS
    - DNS
    - EOF
    - GUID
    - HTML
    - HTTP
    - HTTPS
    - ID
    - IP
    - JSON
    - LHS
    - QPS
    - RAM
    - RHS
    - RPC
    - SLA
    - SMTP
    - SQL
    - SSH
    - TCP
    - TLS
    - TTL
    - UDP
    - UI
    - UID
    - UUID
    - URI
    - URL
    - UTF8
    - VM
    - XML
    - XMPP
    - XSRF
    - XSS
160
    - GRPC
161

162
163
164
165
166
167
168
Rails/ApplicationRecord:
  Enabled: true
  Exclude:
    # Models in database migrations should not subclass from ApplicationRecord
    # as they need to be as decoupled from application code as possible
    - db/**/*.rb
    - lib/gitlab/background_migration/**/*.rb
169
    - ee/lib/ee/gitlab/background_migration/**/*.rb
170
171
172
173
174
    - lib/gitlab/database/**/*.rb
    - spec/**/*.rb
    - ee/db/**/*.rb
    - ee/spec/**/*.rb

175
176
177
178
179
180
181
182
Rails/FindBy:
  Enabled: true
  Include:
    - 'ee/app/**/*.rb'
    - 'ee/lib/**/*.rb'
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'

183
# GitLab ###################################################################
184
185
186
187
188

Gitlab/ModuleWithInstanceVariables:
  Enable: true
  Exclude:
    # We ignore Rails helpers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
189
    - app/helpers/**/*_helper.rb
190
    - ee/app/helpers/**/*_helper.rb
191
    # We ignore Rails mailers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
192
    - app/mailers/emails/**/*.rb
193
    - ee/**/emails/**/*.rb
194
195
196
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
197

198
199
200
201
202
Gitlab/ConstGetInheritFalse:
  Enabled: true
  Exclude:
    - 'qa/bin/*'

203
204
Gitlab/HTTParty:
  Enabled: true
205
206
207
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
208

209
210
211
212
213
214
215
216
217
218
219
220
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
221

222
223
224
225
226
227
228
229
Gitlab/DuplicateSpecLocation:
  Exclude:
    - ee/spec/helpers/auth_helper_spec.rb
    - ee/spec/lib/gitlab/gl_repository_spec.rb
    - ee/spec/services/merge_requests/refresh_service_spec.rb
    - ee/spec/helpers/ee/auth_helper_spec.rb
    - ee/spec/services/ee/merge_requests/refresh_service_spec.rb

230
231
232
233
234
Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
235
236
237

Style/ReturnNil:
  Enabled: true
238
239
240
241
242

# It isn't always safe to replace `=~` with `.match?`, especially when there are
# nil values on the left hand side
Performance/RegexpMatch:
  Enabled: false
243
244
245
246
247
248

ActiveRecordAssociationReload:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
249

250
251
252
253
254
255
Naming/PredicateName:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

256
257
258
259
260
261
RSpec/FactoriesInMigrationSpecs:
  Enabled: true
  Include:
    - 'spec/migrations/**/*.rb'
    - 'ee/spec/migrations/**/*.rb'
    - 'spec/lib/gitlab/background_migration/**/*.rb'
262
263
    - 'spec/lib/ee/gitlab/background_migration/**/*.rb'
    - 'ee/spec/lib/ee/gitlab/background_migration/**/*.rb'
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

Cop/IncludeSidekiqWorker:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

Gitlab/Union:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

Cop/SidekiqOptionsQueue:
  Enabled: true
  Exclude:
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'

Graphql/AuthorizeTypes:
  Enabled: true
  Exclude:
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'

RSpec/EnvAssignment:
  Enable: true
  Include:
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'
  Exclude:
    - 'spec/**/fast_spec_helper.rb'
    - 'ee/spec/**/fast_spec_helper.rb'
    - 'spec/**/spec_helper.rb'
    - 'ee/spec/**/spec_helper.rb'
299
300
301
302
303
304
305
306
RSpec/BeSuccessMatcher:
  Enabled: true
  Include:
    - 'spec/controllers/**/*'
    - 'ee/spec/controllers/**/*'
    - 'spec/support/shared_examples/controllers/**/*'
    - 'ee/spec/support/shared_examples/controllers/**/*'
    - 'spec/support/controllers/**/*'
307
    - 'ee/spec/support/controllers/**/*'
308

309
310
311
312
313
Scalability/FileUploads:
  Enabled: true
  Include:
    - 'lib/api/**/*.rb'
    - 'ee/lib/api/**/*.rb'
314
315
316
317
318
319

Graphql/Descriptions:
  Enabled: true
  Include:
    - 'app/graphql/**/*'
    - 'ee/app/graphql/**/*'
320
321
322

RSpec/AnyInstanceOf:
  Enabled: false
323
324
325
326
327
328

# Cops for upgrade to gitlab-styles 3.1.0
RSpec/ImplicitSubject:
  Enabled: false

RSpec/LeakyConstantDeclaration:
329
330
331
332
  Enabled: true
  Exclude:
    - 'spec/**/*.rb'
    - 'qa/spec/**/*.rb'
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

RSpec/EmptyLineAfterHook:
  Enabled: false

RSpec/HooksBeforeExamples:
  Enabled: false

RSpec/EmptyLineAfterExample:
  Enabled: false

RSpec/Be:
  Enabled: false

RSpec/DescribedClass:
  Enabled: false

RSpec/SharedExamples:
  Enabled: false

RSpec/EmptyLineAfterExampleGroup:
  Enabled: false

RSpec/ReceiveNever:
  Enabled: false

RSpec/MissingExampleGroupArgument:
  Enabled: false

RSpec/UnspecifiedException:
  Enabled: false

364
RSpec/HaveGitlabHttpStatus:
365
  Enabled: true
366
367
  Exclude:
    - 'spec/support/matchers/have_gitlab_http_status.rb'
368
  Include:
369
370
    - 'spec/**/*'
    - 'ee/spec/**/*'
371

372
373
374
375
Style/MultilineWhenThen:
  Enabled: false

Style/FloatDivision:
376
  Enabled: false
377
378
379

Cop/BanCatchThrow:
  Enabled: true
380
381
382

Performance/ReadlinesEach:
  Enabled: true
383

384
385
386
387
388
389
Performance/ChainArrayAllocation:
  Enabled: true
  Include:
    - 'lib/gitlab/import_export/**/*'
    - 'ee/lib/gitlab/import_export/**/*'
    - 'ee/lib/ee/gitlab/import_export/**/*'