2017-09-19 15:25:42 +00:00
|
|
|
inherit_gem:
|
|
|
|
gitlab-styles:
|
|
|
|
- rubocop-default.yml
|
2016-05-21 23:27:15 +00:00
|
|
|
|
2016-06-29 16:00:22 +00:00
|
|
|
inherit_from: .rubocop_todo.yml
|
2018-10-09 17:18:53 +00:00
|
|
|
require:
|
|
|
|
- ./rubocop/rubocop
|
|
|
|
- rubocop-rspec
|
2016-06-29 16:00:22 +00:00
|
|
|
|
2020-03-31 12:08:09 +00:00
|
|
|
inherit_mode:
|
|
|
|
merge:
|
|
|
|
- Include
|
|
|
|
|
2016-03-21 02:49:12 +00:00
|
|
|
AllCops:
|
2019-08-14 23:16:55 +00:00
|
|
|
TargetRubyVersion: 2.6
|
2018-12-17 22:52:17 +00:00
|
|
|
TargetRailsVersion: 5.0
|
2016-03-21 02:49:12 +00:00
|
|
|
Exclude:
|
|
|
|
- 'vendor/**/*'
|
2017-02-02 18:40:49 +00:00
|
|
|
- 'node_modules/**/*'
|
2016-06-09 12:39:16 +00:00
|
|
|
- 'db/fixtures/**/*'
|
2018-07-25 08:59:23 +00:00
|
|
|
- 'db/schema.rb'
|
|
|
|
- 'ee/db/geo/schema.rb'
|
2016-03-21 02:49:12 +00:00
|
|
|
- 'tmp/**/*'
|
|
|
|
- 'bin/**/*'
|
2016-05-19 20:32:07 +00:00
|
|
|
- 'generator_templates/**/*'
|
2017-02-28 12:13:01 +00:00
|
|
|
- 'builds/**/*'
|
2018-02-26 15:33:38 +00:00
|
|
|
- 'plugins/**/*'
|
2018-01-23 15:42:58 +00:00
|
|
|
CacheRootDirectory: tmp
|
2016-03-21 02:49:12 +00:00
|
|
|
|
2018-02-13 14:41:47 +00:00
|
|
|
# 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/**/*'
|
|
|
|
|
2018-08-10 15:17:08 +00:00
|
|
|
# TODO: Move this to gitlab-styles
|
|
|
|
Style/SafeNavigation:
|
|
|
|
Enabled: false
|
|
|
|
|
2018-09-28 09:43:07 +00:00
|
|
|
# Frozen String Literal
|
|
|
|
Style/FrozenStringLiteralComment:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'config.ru'
|
|
|
|
- 'Dangerfile'
|
|
|
|
- 'Gemfile'
|
|
|
|
- 'Rakefile'
|
|
|
|
- 'app/views/**/*'
|
|
|
|
- 'config/**/*'
|
|
|
|
- 'danger/**/*'
|
|
|
|
- 'db/**/*'
|
2019-08-27 17:46:42 +00:00
|
|
|
- 'ee/db/**/*'
|
|
|
|
- 'ee/lib/tasks/**/*'
|
2018-10-08 14:50:39 +00:00
|
|
|
- 'lib/tasks/**/*'
|
2018-09-28 09:43:07 +00:00
|
|
|
- 'qa/**/*'
|
|
|
|
- 'rubocop/**/*'
|
|
|
|
- 'scripts/**/*'
|
|
|
|
|
2018-10-09 17:18:53 +00:00
|
|
|
RSpec/FilePath:
|
|
|
|
Exclude:
|
|
|
|
- 'qa/**/*'
|
2019-07-18 19:11:09 +00:00
|
|
|
- 'spec/frontend/fixtures/*'
|
|
|
|
- 'ee/spec/frontend/fixtures/*'
|
2018-10-09 17:18:53 +00:00
|
|
|
- 'spec/requests/api/v3/*'
|
|
|
|
|
2018-03-08 12:56:54 +00:00
|
|
|
Naming/FileName:
|
|
|
|
ExpectMatchingDefinition: true
|
|
|
|
Exclude:
|
2018-07-25 08:59:23 +00:00
|
|
|
- 'db/**/*'
|
|
|
|
- 'ee/db/**/*'
|
2018-03-08 12:56:54 +00:00
|
|
|
- 'spec/**/*'
|
|
|
|
- 'features/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
|
|
|
- 'qa/spec/**/*'
|
|
|
|
- 'qa/qa/specs/**/*'
|
|
|
|
- 'qa/bin/*'
|
2019-04-12 08:34:51 +00:00
|
|
|
- 'ee/bin/*'
|
2018-03-08 12:56:54 +00:00
|
|
|
- 'config/**/*'
|
2018-10-15 13:59:00 +00:00
|
|
|
- 'ee/config/**/*'
|
2018-03-08 12:56:54 +00:00
|
|
|
- 'lib/generators/**/*'
|
2018-08-08 06:38:39 +00:00
|
|
|
- 'locale/unfound_translations.rb'
|
|
|
|
- 'ee/locale/unfound_translations.rb'
|
2018-03-08 12:56:54 +00:00
|
|
|
- 'ee/lib/generators/**/*'
|
2018-10-25 08:11:19 +00:00
|
|
|
- 'qa/qa/scenario/test/integration/ldap_no_tls.rb'
|
|
|
|
- 'qa/qa/scenario/test/integration/ldap_tls.rb'
|
2018-10-24 13:17:29 +00:00
|
|
|
|
2018-03-08 12:56:54 +00:00
|
|
|
IgnoreExecutableScripts: true
|
|
|
|
AllowedAcronyms:
|
|
|
|
- EE
|
|
|
|
- JSON
|
|
|
|
- LDAP
|
2018-10-10 15:02:43 +00:00
|
|
|
- SAML
|
2019-08-27 17:46:42 +00:00
|
|
|
- SSO
|
2018-03-08 12:56:54 +00:00
|
|
|
- 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
|
2019-01-07 10:40:54 +00:00
|
|
|
- GRPC
|
2018-03-08 12:56:54 +00:00
|
|
|
|
2019-03-29 11:23:05 +00:00
|
|
|
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
|
2020-01-14 09:08:19 +00:00
|
|
|
- ee/lib/ee/gitlab/background_migration/**/*.rb
|
2019-03-29 11:23:05 +00:00
|
|
|
- lib/gitlab/database/**/*.rb
|
|
|
|
- spec/**/*.rb
|
|
|
|
- ee/db/**/*.rb
|
|
|
|
- ee/spec/**/*.rb
|
|
|
|
|
2020-03-31 12:08:09 +00:00
|
|
|
Rails/FindBy:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'ee/app/**/*.rb'
|
|
|
|
- 'ee/lib/**/*.rb'
|
|
|
|
- 'spec/**/*.rb'
|
|
|
|
- 'ee/spec/**/*.rb'
|
|
|
|
|
2018-09-21 12:05:37 +00:00
|
|
|
# GitLab ###################################################################
|
2017-11-22 07:50:36 +00:00
|
|
|
|
|
|
|
Gitlab/ModuleWithInstanceVariables:
|
|
|
|
Enable: true
|
|
|
|
Exclude:
|
|
|
|
# We ignore Rails helpers right now because it's hard to workaround it
|
2017-12-15 11:37:57 +00:00
|
|
|
- app/helpers/**/*_helper.rb
|
2017-12-26 08:30:36 +00:00
|
|
|
- ee/app/helpers/**/*_helper.rb
|
2017-11-22 07:50:36 +00:00
|
|
|
# We ignore Rails mailers right now because it's hard to workaround it
|
2017-12-15 11:37:57 +00:00
|
|
|
- app/mailers/emails/**/*.rb
|
2017-12-26 08:30:36 +00:00
|
|
|
- ee/**/emails/**/*.rb
|
2017-11-22 07:50:36 +00:00
|
|
|
# We ignore spec helpers because it usually doesn't matter
|
|
|
|
- spec/support/**/*.rb
|
|
|
|
- features/steps/**/*.rb
|
2018-02-13 14:41:47 +00:00
|
|
|
|
2019-10-16 03:06:12 +00:00
|
|
|
Gitlab/ConstGetInheritFalse:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'qa/bin/*'
|
|
|
|
|
2018-03-13 22:38:25 +00:00
|
|
|
Gitlab/HTTParty:
|
|
|
|
Enabled: true
|
2019-08-26 12:24:25 +00:00
|
|
|
Exclude:
|
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
2018-03-13 22:38:25 +00:00
|
|
|
|
2018-02-13 14:41:47 +00:00
|
|
|
GitlabSecurity/PublicSend:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'config/**/*'
|
|
|
|
- 'db/**/*'
|
|
|
|
- 'features/**/*'
|
|
|
|
- 'lib/**/*.rake'
|
|
|
|
- 'qa/**/*'
|
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/db/**/*'
|
|
|
|
- 'ee/lib/**/*.rake'
|
|
|
|
- 'ee/spec/**/*'
|
2018-12-13 14:46:01 +00:00
|
|
|
|
2020-03-23 15:09:36 +00:00
|
|
|
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
|
|
|
|
|
2018-12-13 14:46:01 +00:00
|
|
|
Cop/InjectEnterpriseEditionModule:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
2019-02-08 12:19:53 +00:00
|
|
|
|
|
|
|
Style/ReturnNil:
|
|
|
|
Enabled: true
|
2019-01-30 18:44:00 +00:00
|
|
|
|
|
|
|
# It isn't always safe to replace `=~` with `.match?`, especially when there are
|
|
|
|
# nil values on the left hand side
|
|
|
|
Performance/RegexpMatch:
|
|
|
|
Enabled: false
|
2019-04-08 13:33:36 +00:00
|
|
|
|
|
|
|
ActiveRecordAssociationReload:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
2019-08-26 12:24:25 +00:00
|
|
|
|
2019-09-25 12:06:15 +00:00
|
|
|
Naming/PredicateName:
|
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
|
|
|
|
2019-08-26 12:24:25 +00:00
|
|
|
RSpec/FactoriesInMigrationSpecs:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'spec/migrations/**/*.rb'
|
|
|
|
- 'ee/spec/migrations/**/*.rb'
|
|
|
|
- 'spec/lib/gitlab/background_migration/**/*.rb'
|
2020-01-14 09:08:19 +00:00
|
|
|
- 'spec/lib/ee/gitlab/background_migration/**/*.rb'
|
|
|
|
- 'ee/spec/lib/ee/gitlab/background_migration/**/*.rb'
|
2019-08-26 12:24:25 +00:00
|
|
|
|
|
|
|
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'
|
2019-08-26 08:04:54 +00:00
|
|
|
RSpec/BeSuccessMatcher:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'spec/controllers/**/*'
|
|
|
|
- 'ee/spec/controllers/**/*'
|
|
|
|
- 'spec/support/shared_examples/controllers/**/*'
|
|
|
|
- 'ee/spec/support/shared_examples/controllers/**/*'
|
|
|
|
- 'spec/support/controllers/**/*'
|
2019-08-26 13:13:41 +00:00
|
|
|
- 'ee/spec/support/controllers/**/*'
|
2019-09-13 13:26:31 +00:00
|
|
|
|
2019-09-10 16:24:10 +00:00
|
|
|
Scalability/FileUploads:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'lib/api/**/*.rb'
|
|
|
|
- 'ee/lib/api/**/*.rb'
|
2019-09-13 13:26:31 +00:00
|
|
|
|
|
|
|
Graphql/Descriptions:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'app/graphql/**/*'
|
|
|
|
- 'ee/app/graphql/**/*'
|
2019-11-07 15:06:33 +00:00
|
|
|
|
|
|
|
RSpec/AnyInstanceOf:
|
|
|
|
Enabled: false
|
2019-12-20 09:24:38 +00:00
|
|
|
|
|
|
|
# Cops for upgrade to gitlab-styles 3.1.0
|
|
|
|
RSpec/ImplicitSubject:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
RSpec/LeakyConstantDeclaration:
|
2020-03-18 21:09:22 +00:00
|
|
|
Enabled: true
|
|
|
|
Exclude:
|
|
|
|
- 'spec/**/*.rb'
|
|
|
|
- 'qa/spec/**/*.rb'
|
2019-12-20 09:24:38 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
|
2020-01-15 18:08:34 +00:00
|
|
|
RSpec/HaveGitlabHttpStatus:
|
2020-01-20 09:08:32 +00:00
|
|
|
Enabled: true
|
2020-02-06 18:08:54 +00:00
|
|
|
Exclude:
|
|
|
|
- 'spec/support/matchers/have_gitlab_http_status.rb'
|
2020-01-20 09:08:32 +00:00
|
|
|
Include:
|
2020-03-03 21:08:37 +00:00
|
|
|
- 'spec/**/*'
|
|
|
|
- 'ee/spec/**/*'
|
2020-01-15 18:08:34 +00:00
|
|
|
|
2019-12-20 09:24:38 +00:00
|
|
|
Style/MultilineWhenThen:
|
|
|
|
Enabled: false
|
|
|
|
|
|
|
|
Style/FloatDivision:
|
2020-01-14 09:08:19 +00:00
|
|
|
Enabled: false
|
2020-03-09 15:07:45 +00:00
|
|
|
|
|
|
|
Cop/BanCatchThrow:
|
|
|
|
Enabled: true
|
2020-03-27 18:07:48 +00:00
|
|
|
|
|
|
|
Performance/ReadlinesEach:
|
|
|
|
Enabled: true
|
2020-03-30 21:08:01 +00:00
|
|
|
|
2020-04-03 09:09:31 +00:00
|
|
|
Performance/ChainArrayAllocation:
|
|
|
|
Enabled: true
|
|
|
|
Include:
|
|
|
|
- 'lib/gitlab/import_export/**/*'
|
|
|
|
- 'ee/lib/gitlab/import_export/**/*'
|
|
|
|
- 'ee/lib/ee/gitlab/import_export/**/*'
|