.rubocop.yml 5.61 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
AllCops:
11
  TargetRubyVersion: 2.6
blackst0ne's avatar
blackst0ne committed
12
  TargetRailsVersion: 5.0
13 14
  Exclude:
    - 'vendor/**/*'
15
    - 'node_modules/**/*'
16
    - 'db/fixtures/**/*'
17 18
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
19 20
    - 'tmp/**/*'
    - 'bin/**/*'
21
    - 'generator_templates/**/*'
22
    - 'builds/**/*'
23
    - 'plugins/**/*'
Lin Jen-Shin's avatar
Lin Jen-Shin committed
24
  CacheRootDirectory: tmp
25

26 27 28 29 30 31 32 33 34 35 36
# 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/**/*'

37 38 39 40
# TODO: Move this to gitlab-styles
Style/SafeNavigation:
  Enabled: false

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

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

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

90 91 92 93 94
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
Sanad Liaquat's avatar
Sanad Liaquat committed
95
    - SAML
96
    - SSO
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
    - 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
151
    - GRPC
152

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

167
# GitLab ###################################################################
168 169 170 171 172

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
173
    - app/helpers/**/*_helper.rb
174
    - ee/app/helpers/**/*_helper.rb
175
    # We ignore Rails mailers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
176
    - app/mailers/emails/**/*.rb
177
    - ee/**/emails/**/*.rb
178 179 180
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
181

182 183
Gitlab/HTTParty:
  Enabled: true
184 185 186
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
187

188 189 190 191 192 193 194 195 196 197 198 199
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
200 201 202 203 204 205

Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
206 207 208

Style/ReturnNil:
  Enabled: true
209 210 211 212 213

# It isn't always safe to replace `=~` with `.match?`, especially when there are
# nil values on the left hand side
Performance/RegexpMatch:
  Enabled: false
214 215 216 217 218 219

ActiveRecordAssociationReload:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
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

RSpec/FactoriesInMigrationSpecs:
  Enabled: true
  Include:
    - 'spec/migrations/**/*.rb'
    - 'ee/spec/migrations/**/*.rb'
    - 'spec/lib/gitlab/background_migration/**/*.rb'
    - 'ee/spec/lib/gitlab/background_migration/**/*.rb'

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

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'
269 270 271 272 273 274 275 276
RSpec/BeSuccessMatcher:
  Enabled: true
  Include:
    - 'spec/controllers/**/*'
    - 'ee/spec/controllers/**/*'
    - 'spec/support/shared_examples/controllers/**/*'
    - 'ee/spec/support/shared_examples/controllers/**/*'
    - 'spec/support/controllers/**/*'
277
    - 'ee/spec/support/controllers/**/*'
278

279 280 281 282 283
Scalability/FileUploads:
  Enabled: true
  Include:
    - 'lib/api/**/*.rb'
    - 'ee/lib/api/**/*.rb'
284 285 286 287 288 289

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