.rubocop.yml 9.28 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

Tan Le's avatar
Tan Le committed
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/**/*'
19
    - 'node_modules/**/*'
20
    - 'db/fixtures/**/*'
21 22
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
23 24
    - 'tmp/**/*'
    - 'bin/**/*'
25
    - 'generator_templates/**/*'
26
    - 'builds/**/*'
27
    - 'plugins/**/*'
Lin Jen-Shin's avatar
Lin Jen-Shin committed
28
  CacheRootDirectory: tmp
29

30 31 32 33 34 35 36 37 38 39 40
# 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/**/*'

41 42 43 44
# TODO: Move this to gitlab-styles
Style/SafeNavigation:
  Enabled: false

45 46 47 48 49 50 51 52 53 54 55 56
# Frozen String Literal
Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - 'config.ru'
    - 'Dangerfile'
    - 'Gemfile'
    - 'Rakefile'
    - 'app/views/**/*'
    - 'config/**/*'
    - 'danger/**/*'
    - 'db/**/*'
57 58
    - 'ee/db/**/*'
    - 'ee/lib/tasks/**/*'
59
    - 'lib/tasks/**/*'
60 61 62 63
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'

64 65 66
RSpec/FilePath:
  Exclude:
    - 'qa/**/*'
67 68
    - 'spec/frontend/fixtures/*'
    - 'ee/spec/frontend/fixtures/*'
69 70
    - 'spec/requests/api/v3/*'

71 72 73
Naming/FileName:
  ExpectMatchingDefinition: true
  Exclude:
74 75
    - 'db/**/*'
    - 'ee/db/**/*'
76 77 78 79 80 81
    - 'spec/**/*'
    - 'features/**/*'
    - 'ee/spec/**/*'
    - 'qa/spec/**/*'
    - 'qa/qa/specs/**/*'
    - 'qa/bin/*'
82
    - 'ee/bin/*'
83
    - 'config/**/*'
84
    - 'ee/config/**/*'
85
    - 'lib/generators/**/*'
86 87
    - 'locale/unfound_translations.rb'
    - 'ee/locale/unfound_translations.rb'
88
    - 'ee/lib/generators/**/*'
Sanad Liaquat's avatar
Sanad Liaquat committed
89 90
    - 'qa/qa/scenario/test/integration/ldap_no_tls.rb'
    - 'qa/qa/scenario/test/integration/ldap_tls.rb'
Sanad Liaquat's avatar
Sanad Liaquat committed
91

92 93 94 95 96
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
Sanad Liaquat's avatar
Sanad Liaquat committed
97
    - SAML
98
    - SSO
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
    - 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
153
    - GRPC
154

155 156 157 158 159 160 161
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
162
    - ee/lib/ee/gitlab/background_migration/**/*.rb
163 164 165 166 167
    - lib/gitlab/database/**/*.rb
    - spec/**/*.rb
    - ee/db/**/*.rb
    - ee/spec/**/*.rb

Tan Le's avatar
Tan Le committed
168 169 170 171 172 173 174 175
Rails/FindBy:
  Enabled: true
  Include:
    - 'ee/app/**/*.rb'
    - 'ee/lib/**/*.rb'
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'

176
# GitLab ###################################################################
177 178 179 180 181

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
182
    - app/helpers/**/*_helper.rb
183
    - ee/app/helpers/**/*_helper.rb
184
    # We ignore Rails mailers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
185
    - app/mailers/emails/**/*.rb
186
    - ee/**/emails/**/*.rb
187 188 189
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
190

191 192 193 194 195
Gitlab/ConstGetInheritFalse:
  Enabled: true
  Exclude:
    - 'qa/bin/*'

196 197
Gitlab/HTTParty:
  Enabled: true
198 199 200
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
201

202 203 204 205 206 207 208 209 210 211 212 213
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
214

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
Gitlab/DuplicateSpecLocation:
  Exclude:
    - ee/spec/helpers/auth_helper_spec.rb
    - ee/spec/lib/gitlab/gl_repository_spec.rb
    - ee/spec/models/namespace_spec.rb
    - ee/spec/services/issues/create_service_spec.rb
    - ee/spec/services/merge_requests/create_service_spec.rb
    - ee/spec/services/merge_requests/refresh_service_spec.rb
    - ee/spec/services/merge_requests/update_service_spec.rb
    - ee/spec/services/system_hooks_service_spec.rb
    - ee/spec/helpers/ee/auth_helper_spec.rb
    - ee/spec/models/ee/namespace_spec.rb
    - ee/spec/services/ee/issues/create_service_spec.rb
    - ee/spec/services/ee/merge_requests/create_service_spec.rb
    - ee/spec/services/ee/merge_requests/refresh_service_spec.rb
    - ee/spec/services/ee/merge_requests/update_service_spec.rb
    - ee/spec/services/ee/system_hooks_service_spec.rb

233 234 235 236 237
Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
238 239 240

Style/ReturnNil:
  Enabled: true
241 242 243 244 245

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

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

Simon Knox's avatar
Simon Knox committed
253 254 255 256 257 258
Naming/PredicateName:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

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

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'
302 303 304 305 306 307 308 309
RSpec/BeSuccessMatcher:
  Enabled: true
  Include:
    - 'spec/controllers/**/*'
    - 'ee/spec/controllers/**/*'
    - 'spec/support/shared_examples/controllers/**/*'
    - 'ee/spec/support/shared_examples/controllers/**/*'
    - 'spec/support/controllers/**/*'
310
    - 'ee/spec/support/controllers/**/*'
311

312 313 314 315 316
Scalability/FileUploads:
  Enabled: true
  Include:
    - 'lib/api/**/*.rb'
    - 'ee/lib/api/**/*.rb'
317 318 319 320 321 322

Graphql/Descriptions:
  Enabled: true
  Include:
    - 'app/graphql/**/*'
    - 'ee/app/graphql/**/*'
323 324 325

RSpec/AnyInstanceOf:
  Enabled: false
326 327 328 329 330

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

331 332 333 334 335
RSpec/LeakyConstantDeclaration:
  Enabled: true
  Exclude:
    - 'spec/**/*.rb'
    - 'qa/spec/**/*.rb'
Ryan Cobb's avatar
Ryan Cobb committed
336 337 338 339 340 341 342
    - 'ee/spec/presenters/security/vulnerable_project_presenter_spec.rb'
    - 'ee/spec/serializers/vulnerable_project_entity_spec.rb'
    - 'ee/spec/services/clusters/applications/check_upgrade_progress_service_spec.rb'
    - 'ee/spec/services/dashboard/projects/list_service_spec.rb'
    - 'ee/spec/services/metrics/dashboard/clone_dashboard_service_spec.rb'
    - 'ee/spec/support/shared_contexts/epic_aggregate_constants.rb'
    - 'ee/spec/workers/elastic_namespace_rollout_worker_spec.rb'
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
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

374
RSpec/HaveGitlabHttpStatus:
375
  Enabled: true
376 377
  Exclude:
    - 'spec/support/matchers/have_gitlab_http_status.rb'
378
  Include:
379 380
    - 'spec/**/*'
    - 'ee/spec/**/*'
381

382 383 384 385
Style/MultilineWhenThen:
  Enabled: false

Style/FloatDivision:
386
  Enabled: false
Nick Thomas's avatar
Nick Thomas committed
387 388 389

Cop/BanCatchThrow:
  Enabled: true
390 391 392

Performance/ReadlinesEach:
  Enabled: true
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

# https://gitlab.com/gitlab-org/gitlab/-/issues/212541
RSpec/RepeatedExample:
  Exclude:
    - 'spec/features/issues/filtered_search/filter_issues_spec.rb'
    - 'spec/features/merge_request/user_posts_diff_notes_spec.rb'
    - 'spec/features/projects/files/template_type_dropdown_spec.rb'
    - 'spec/finders/environments_finder_spec.rb'
    - 'spec/frontend/fixtures/merge_requests.rb'
    - 'spec/graphql/gitlab_schema_spec.rb'
    - 'spec/helpers/users_helper_spec.rb'
    - 'spec/lib/gitlab/closing_issue_extractor_spec.rb'
    - 'spec/lib/gitlab/danger/changelog_spec.rb'
    - 'spec/lib/gitlab/git/blob_spec.rb'
    - 'spec/lib/gitlab/import_export/project/relation_factory_spec.rb'
    - 'spec/models/ability_spec.rb'
    - 'spec/models/ci/build_spec.rb'
    - 'spec/models/concerns/issuable_spec.rb'
    - 'spec/models/project_services/chat_message/pipeline_message_spec.rb'
    - 'spec/routing/admin_routing_spec.rb'
    - 'spec/rubocop/cop/migration/update_large_table_spec.rb'
    - 'spec/services/notification_service_spec.rb'
    - 'spec/services/web_hook_service_spec.rb'
    - 'ee/spec/services/boards/lists/update_service_spec.rb'
    - 'ee/spec/services/geo/repository_verification_primary_service_spec.rb'