.rubocop.yml 10.9 KB
Newer Older
R
Rémy Coutable 已提交
1 2 3
inherit_gem:
  gitlab-styles:
    - rubocop-default.yml
R
Robert Speicher 已提交
4

Z
Z.J. van de Weg 已提交
5
inherit_from: .rubocop_todo.yml
6 7 8
require:
  - ./rubocop/rubocop
  - rubocop-rspec
Z
Z.J. van de Weg 已提交
9

10 11 12 13
inherit_mode:
  merge:
    - Include

14
AllCops:
15
  TargetRubyVersion: 2.6
B
blackst0ne 已提交
16
  TargetRailsVersion: 5.0
17 18
  Exclude:
    - 'vendor/**/*'
M
Mike Greiling 已提交
19
    - 'node_modules/**/*'
S
Sean McGivern 已提交
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/**/*'
L
Lin Jen-Shin 已提交
29
  CacheRootDirectory: tmp
30

31 32 33 34 35 36
Cop/AvoidKeywordArgumentsInSidekiqWorkers:
  Enabled: true
  Include:
    - 'app/workers/**/*'
    - 'ee/app/workers/**/*'

37 38 39 40 41 42
Cop/StaticTranslationDefinition:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

43 44 45 46 47 48 49 50 51 52 53
# 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/**/*'

54 55 56 57
# TODO: Move this to gitlab-styles
Style/SafeNavigation:
  Enabled: false

G
gfyoung 已提交
58 59 60 61 62 63 64 65 66 67 68 69
# Frozen String Literal
Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - 'config.ru'
    - 'Dangerfile'
    - 'Gemfile'
    - 'Rakefile'
    - 'app/views/**/*'
    - 'config/**/*'
    - 'danger/**/*'
    - 'db/**/*'
R
Robert Speicher 已提交
70 71
    - 'ee/db/**/*'
    - 'ee/lib/tasks/**/*'
72
    - 'lib/tasks/**/*'
G
gfyoung 已提交
73 74 75 76
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'

77 78 79
RSpec/FilePath:
  Exclude:
    - 'qa/**/*'
80 81
    - 'spec/frontend/fixtures/*'
    - 'ee/spec/frontend/fixtures/*'
82 83
    - 'spec/requests/api/v3/*'

84 85 86
Naming/FileName:
  ExpectMatchingDefinition: true
  Exclude:
87 88
    - 'db/**/*'
    - 'ee/db/**/*'
89 90 91 92 93 94
    - 'spec/**/*'
    - 'features/**/*'
    - 'ee/spec/**/*'
    - 'qa/spec/**/*'
    - 'qa/qa/specs/**/*'
    - 'qa/bin/*'
95
    - 'ee/bin/*'
96
    - 'config/**/*'
97
    - 'ee/config/**/*'
98
    - 'lib/generators/**/*'
M
Mark Chao 已提交
99 100
    - 'locale/unfound_translations.rb'
    - 'ee/locale/unfound_translations.rb'
101
    - 'ee/lib/generators/**/*'
S
Sanad Liaquat 已提交
102 103
    - 'qa/qa/scenario/test/integration/ldap_no_tls.rb'
    - 'qa/qa/scenario/test/integration/ldap_tls.rb'
S
Sanad Liaquat 已提交
104

105 106 107 108 109
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
S
Sanad Liaquat 已提交
110
    - SAML
R
Robert Speicher 已提交
111
    - SSO
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
    - 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
166
    - GRPC
167

168 169 170 171 172 173 174
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
175
    - ee/lib/ee/gitlab/background_migration/**/*.rb
176 177 178 179 180
    - lib/gitlab/database/**/*.rb
    - spec/**/*.rb
    - ee/db/**/*.rb
    - ee/spec/**/*.rb

181 182 183 184 185 186 187 188
Rails/FindBy:
  Enabled: true
  Include:
    - 'ee/app/**/*.rb'
    - 'ee/lib/**/*.rb'
    - 'spec/**/*.rb'
    - 'ee/spec/**/*.rb'

189
# GitLab ###################################################################
190 191 192 193 194

Gitlab/ModuleWithInstanceVariables:
  Enable: true
  Exclude:
    # We ignore Rails helpers right now because it's hard to workaround it
L
Lin Jen-Shin 已提交
195
    - app/helpers/**/*_helper.rb
196
    - ee/app/helpers/**/*_helper.rb
197
    # We ignore Rails mailers right now because it's hard to workaround it
L
Lin Jen-Shin 已提交
198
    - app/mailers/emails/**/*.rb
199
    - ee/**/emails/**/*.rb
200 201 202
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
203

204 205 206 207 208
Gitlab/ConstGetInheritFalse:
  Enabled: true
  Exclude:
    - 'qa/bin/*'

209 210 211 212 213
Gitlab/ChangeTimezone:
  Enabled: true
  Exclude:
    - config/initializers/time_zone.rb

214 215
Gitlab/HTTParty:
  Enabled: true
216 217 218
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
219

220
Gitlab/Json:
221
  Enabled: true
222 223 224 225
  Exclude:
    - 'db/**/*'
    - 'qa/**/*'
    - 'scripts/**/*'
226 227
    - 'lib/rspec_flaky/**/*'
    - 'lib/quality/**/*'
228

229 230 231 232 233 234 235 236 237 238 239 240
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
241

242 243 244 245 246 247
Gitlab/DuplicateSpecLocation:
  Exclude:
    - ee/spec/lib/gitlab/gl_repository_spec.rb
    - ee/spec/services/merge_requests/refresh_service_spec.rb
    - ee/spec/services/ee/merge_requests/refresh_service_spec.rb

248 249 250 251 252
Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
253 254 255

Style/ReturnNil:
  Enabled: true
N
Nick Thomas 已提交
256 257 258 259 260

# It isn't always safe to replace `=~` with `.match?`, especially when there are
# nil values on the left hand side
Performance/RegexpMatch:
  Enabled: false
261 262 263 264 265 266

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

268 269 270 271 272 273
Naming/PredicateName:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'

274 275 276 277 278 279
RSpec/FactoriesInMigrationSpecs:
  Enabled: true
  Include:
    - 'spec/migrations/**/*.rb'
    - 'ee/spec/migrations/**/*.rb'
    - 'spec/lib/gitlab/background_migration/**/*.rb'
280 281
    - 'spec/lib/ee/gitlab/background_migration/**/*.rb'
    - 'ee/spec/lib/ee/gitlab/background_migration/**/*.rb'
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

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'
317 318 319 320 321 322 323 324
RSpec/BeSuccessMatcher:
  Enabled: true
  Include:
    - 'spec/controllers/**/*'
    - 'ee/spec/controllers/**/*'
    - 'spec/support/shared_examples/controllers/**/*'
    - 'ee/spec/support/shared_examples/controllers/**/*'
    - 'spec/support/controllers/**/*'
325
    - 'ee/spec/support/controllers/**/*'
326

327 328 329 330 331
Scalability/FileUploads:
  Enabled: true
  Include:
    - 'lib/api/**/*.rb'
    - 'ee/lib/api/**/*.rb'
332 333 334 335 336 337

Graphql/Descriptions:
  Enabled: true
  Include:
    - 'app/graphql/**/*'
    - 'ee/app/graphql/**/*'
338 339 340

RSpec/AnyInstanceOf:
  Enabled: false
341 342 343 344 345

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

346
# WIP See https://gitlab.com/gitlab-org/gitlab/-/issues/211580
347
RSpec/LeakyConstantDeclaration:
348 349
  Enabled: true
  Exclude:
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
    - 'spec/db/schema_spec.rb'
    - 'spec/lib/feature_spec.rb'
    - 'spec/lib/gitlab/ci/build/credentials/factory_spec.rb'
    - 'spec/lib/gitlab/ci/config/entry/retry_spec.rb'
    - 'spec/lib/gitlab/cluster/mixins/puma_cluster_spec.rb'
    - 'spec/lib/gitlab/cluster/mixins/unicorn_http_server_spec.rb'
    - 'spec/lib/gitlab/config/entry/factory_spec.rb'
    - 'spec/lib/gitlab/config/entry/simplifiable_spec.rb'
    - 'spec/lib/gitlab/database/migration_helpers_spec.rb'
    - 'spec/lib/gitlab/database/obsolete_ignored_columns_spec.rb'
    - 'spec/lib/gitlab/database/with_lock_retries_spec.rb'
    - 'spec/lib/gitlab/git/diff_collection_spec.rb'
    - 'spec/lib/gitlab/graphql/pagination/keyset/connection_spec.rb'
    - 'spec/lib/gitlab/health_checks/master_check_spec.rb'
    - 'spec/lib/gitlab/import_export/attribute_configuration_spec.rb'
    - 'spec/lib/gitlab/import_export/import_test_coverage_spec.rb'
    - 'spec/lib/gitlab/import_export/project/relation_factory_spec.rb'
    - 'spec/lib/gitlab/jira_import/issues_importer_spec.rb'
    - 'spec/lib/gitlab/no_cache_headers_spec.rb'
    - 'spec/lib/gitlab/path_regex_spec.rb'
    - 'spec/lib/gitlab/quick_actions/dsl_spec.rb'
    - 'spec/lib/gitlab/sidekiq_middleware/client_metrics_spec.rb'
    - 'spec/lib/gitlab/sidekiq_middleware/server_metrics_spec.rb'
    - 'spec/lib/gitlab/view/presenter/factory_spec.rb'
    - 'spec/lib/marginalia_spec.rb'
    - 'spec/lib/omni_auth/strategies/jwt_spec.rb'
    - 'spec/lib/system_check/simple_executor_spec.rb'
    - 'spec/lib/system_check_spec.rb'
    - 'spec/mailers/notify_spec.rb'
    - 'spec/migrations/20191125114345_add_admin_mode_protected_path_spec.rb'
    - 'spec/migrations/encrypt_plaintext_attributes_on_application_settings_spec.rb'
    - 'spec/models/clusters/cluster_spec.rb'
    - 'spec/models/concerns/batch_destroy_dependent_associations_spec.rb'
    - 'spec/models/concerns/blocks_json_serialization_spec.rb'
    - 'spec/models/concerns/bulk_insert_safe_spec.rb'
    - 'spec/models/concerns/bulk_insertable_associations_spec.rb'
    - 'spec/models/concerns/mentionable_spec.rb'
    - 'spec/models/concerns/reactive_caching_spec.rb'
    - 'spec/models/concerns/triggerable_hooks_spec.rb'
    - 'spec/models/repository_spec.rb'
    - 'spec/models/tree_spec.rb'
    - 'spec/policies/merge_request_policy_spec.rb'
    - 'spec/requests/api/graphql/tasks/task_completion_status_spec.rb'
    - 'spec/requests/api/statistics_spec.rb'
    - 'spec/rubocop/cop/rspec/env_assignment_spec.rb'
    - 'spec/serializers/commit_entity_spec.rb'
    - 'spec/services/clusters/applications/check_installation_progress_service_spec.rb'
    - 'spec/services/clusters/applications/check_uninstall_progress_service_spec.rb'
    - 'spec/services/issues/resolve_discussions_spec.rb'
    - 'spec/support/shared_contexts/spam_constants.rb'
    - 'spec/support/shared_examples/quick_actions/issuable/issuable_quick_actions_shared_examples.rb'
    - 'spec/support_specs/matchers/exceed_query_limit_helpers_spec.rb'
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

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

433
RSpec/HaveGitlabHttpStatus:
434
  Enabled: true
435 436
  Exclude:
    - 'spec/support/matchers/have_gitlab_http_status.rb'
437
  Include:
438 439
    - 'spec/**/*'
    - 'ee/spec/**/*'
440

441 442 443 444
Style/MultilineWhenThen:
  Enabled: false

Style/FloatDivision:
445
  Enabled: false
446 447 448

Cop/BanCatchThrow:
  Enabled: true
449 450 451

Performance/ReadlinesEach:
  Enabled: true
452

453 454 455 456 457 458
Performance/ChainArrayAllocation:
  Enabled: true
  Include:
    - 'lib/gitlab/import_export/**/*'
    - 'ee/lib/gitlab/import_export/**/*'
    - 'ee/lib/ee/gitlab/import_export/**/*'
459 460 461 462 463

Rails/TimeZone:
  Enabled: true
  EnforcedStyle: 'flexible'
  Include:
464
    - 'app/controllers/**/*'
465
    - 'app/services/**/*'
466
    - 'spec/controllers/**/*'
467
    - 'spec/services/**/*'
468
    - 'ee/app/controllers/**/*'
469
    - 'ee/app/services/**/*'
470
    - 'ee/spec/controllers/**/*'
471 472
    - 'ee/spec/services/**/*'