.rubocop.yml 2.88 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
require: ./rubocop/rubocop
Z.J. van de Weg's avatar
Z.J. van de Weg committed
7

8
AllCops:
9
  TargetRailsVersion: 4.2
10 11
  Exclude:
    - 'vendor/**/*'
12
    - 'node_modules/**/*'
13
    - 'db/fixtures/**/*'
14 15
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
16 17
    - 'tmp/**/*'
    - 'bin/**/*'
18
    - 'generator_templates/**/*'
19
    - 'builds/**/*'
20
    - 'plugins/**/*'
Lin Jen-Shin's avatar
Lin Jen-Shin committed
21
  CacheRootDirectory: tmp
22

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

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

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

57 58 59
Naming/FileName:
  ExpectMatchingDefinition: true
  Exclude:
60 61
    - 'db/**/*'
    - 'ee/db/**/*'
62 63 64 65 66 67 68 69
    - 'spec/**/*'
    - 'features/**/*'
    - 'ee/spec/**/*'
    - 'qa/spec/**/*'
    - 'qa/qa/specs/**/*'
    - 'qa/bin/*'
    - 'config/**/*'
    - 'lib/generators/**/*'
70 71
    - 'locale/unfound_translations.rb'
    - 'ee/locale/unfound_translations.rb'
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 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
    - 'ee/lib/generators/**/*'
  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
    - 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

133
# GitLab ###################################################################
134 135 136 137 138

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
139
    - app/helpers/**/*_helper.rb
140
    - ee/app/helpers/**/*_helper.rb
141
    # We ignore Rails mailers right now because it's hard to workaround it
Lin Jen-Shin's avatar
Lin Jen-Shin committed
142
    - app/mailers/emails/**/*.rb
143
    - ee/**/emails/**/*.rb
144 145 146
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb
147

148 149 150
Gitlab/HTTParty:
  Enabled: true

151 152 153 154 155 156 157 158 159 160 161 162
GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'