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

5
inherit_from: .rubocop_todo.yml
6 7 8
require:
  - ./rubocop/rubocop
  - rubocop-rspec
9

10
AllCops:
11
  TargetRubyVersion: 2.5
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/**/*'
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 53
# Frozen String Literal
Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - 'config.ru'
    - 'Dangerfile'
    - 'Gemfile'
    - 'Rakefile'
    - 'app/views/**/*'
    - 'config/**/*'
    - 'danger/**/*'
    - 'db/**/*'
    - 'ee/**/*'
54
    - 'lib/tasks/**/*'
55 56 57 58 59
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'
    - 'spec/**/*'

60 61 62 63 64 65 66
RSpec/FilePath:
  Exclude:
    - 'qa/**/*'
    - 'spec/javascripts/fixtures/*'
    - 'ee/spec/javascripts/fixtures/*'
    - 'spec/requests/api/v3/*'

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

87 88 89 90 91
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
Sanad Liaquat's avatar
Sanad Liaquat committed
92
    - SAML
93 94 95 96 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
    - 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
147
    - GRPC
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162
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

163
# GitLab ###################################################################
164 165 166 167 168

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

178 179 180
Gitlab/HTTParty:
  Enabled: true

181 182 183 184 185 186 187 188 189 190 191 192
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
193 194 195 196 197 198

Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
199 200 201

Style/ReturnNil:
  Enabled: true
202 203 204 205 206

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