.rubocop.yml 3.34 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
  TargetRailsVersion: 5.0
12 13
  Exclude:
    - 'vendor/**/*'
14
    - 'node_modules/**/*'
15
    - 'db/fixtures/**/*'
16 17
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
18 19
    - 'tmp/**/*'
    - 'bin/**/*'
20
    - 'generator_templates/**/*'
21
    - 'builds/**/*'
22
    - 'plugins/**/*'
23
  CacheRootDirectory: tmp
24

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

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

40 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/**/*'
    - 'ee/**/*'
53
    - 'lib/tasks/**/*'
54 55 56 57 58
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'
    - 'spec/**/*'

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

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

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

148
# GitLab ###################################################################
149 150 151 152 153

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
154
    - app/helpers/**/*_helper.rb
155
    - ee/app/helpers/**/*_helper.rb
156
    # We ignore Rails mailers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
157
    - app/mailers/emails/**/*.rb
158
    - ee/**/emails/**/*.rb
159 160 161
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
162

163 164 165
Gitlab/HTTParty:
  Enabled: true

166 167 168 169 170 171 172 173 174 175 176 177
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'
178 179 180 181 182 183

Cop/InjectEnterpriseEditionModule:
  Enabled: true
  Exclude:
    - 'spec/**/*'
    - 'ee/spec/**/*'
184 185 186

Style/ReturnNil:
  Enabled: true