gitlab-org--gitlab-foss/.rubocop.yml

inherit_gem:
  gitlab-styles:
    - rubocop-default.yml

inherit_from: .rubocop_todo.yml
require:
  - ./rubocop/rubocop
  - rubocop-rspec

AllCops:
  TargetRailsVersion: 5.0
  Exclude:
    - 'vendor/**/*'
    - 'node_modules/**/*'
    - 'db/fixtures/**/*'
    - 'db/schema.rb'
    - 'ee/db/geo/schema.rb'
    - 'tmp/**/*'
    - 'bin/**/*'
    - 'generator_templates/**/*'
    - 'builds/**/*'
    - 'plugins/**/*'
  CacheRootDirectory: tmp

# 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/**/*'

# TODO: Move this to gitlab-styles
Style/SafeNavigation:
  Enabled: false

# Frozen String Literal
Style/FrozenStringLiteralComment:
  Enabled: true
  Exclude:
    - 'config.ru'
    - 'Dangerfile'
    - 'Gemfile'
    - 'Rakefile'
    - 'app/views/**/*'
    - 'config/**/*'
    - 'danger/**/*'
    - 'db/**/*'
    - 'ee/**/*'
    - 'lib/tasks/**/*'
    - 'qa/**/*'
    - 'rubocop/**/*'
    - 'scripts/**/*'
    - 'spec/**/*'

RSpec/FilePath:
  Exclude:
    - 'qa/**/*'
    - 'spec/javascripts/fixtures/*'
    - 'ee/spec/javascripts/fixtures/*'
    - 'spec/requests/api/v3/*'

Naming/FileName:
  ExpectMatchingDefinition: true
  Exclude:
    - 'db/**/*'
    - 'ee/db/**/*'
    - 'spec/**/*'
    - 'features/**/*'
    - 'ee/spec/**/*'
    - 'qa/spec/**/*'
    - 'qa/qa/specs/**/*'
    - 'qa/bin/*'
    - 'config/**/*'
    - 'ee/config/**/*'
    - 'lib/generators/**/*'
    - 'locale/unfound_translations.rb'
    - 'ee/locale/unfound_translations.rb'
    - 'ee/lib/generators/**/*'
    - 'qa/qa/scenario/test/integration/ldap_no_tls.rb'
    - 'qa/qa/scenario/test/integration/ldap_tls.rb'

  IgnoreExecutableScripts: true
  AllowedAcronyms:
    - EE
    - JSON
    - LDAP
    - SAML
    - 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
    - GRPC

# GitLab ###################################################################

Gitlab/ModuleWithInstanceVariables:
  Enable: true
  Exclude:
    # We ignore Rails helpers right now because it's hard to workaround it
    - app/helpers/**/*_helper.rb
    - ee/app/helpers/**/*_helper.rb
    # We ignore Rails mailers right now because it's hard to workaround it
    - app/mailers/emails/**/*.rb
    - ee/**/emails/**/*.rb
    # We ignore spec helpers because it usually doesn't matter
    - spec/support/**/*.rb
    - features/steps/**/*.rb

Gitlab/HTTParty:
  Enabled: true

GitlabSecurity/PublicSend:
  Enabled: true
  Exclude:
    - 'config/**/*'
    - 'db/**/*'
    - 'features/**/*'
    - 'lib/**/*.rake'
    - 'qa/**/*'
    - 'spec/**/*'
    - 'ee/db/**/*'
    - 'ee/lib/**/*.rake'
    - 'ee/spec/**/*'

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

Style/ReturnNil:
  Enabled: true
Use gitlab-styles Signed-off-by: Rémy Coutable <remy@rymai.me> 2017-09-19 11:25:42 -04:00			`inherit_gem:`
			`gitlab-styles:`
			`- rubocop-default.yml`
Add rubocop-rspec Almost all cops are starting as disabled until we can fix their violations. 2016-05-21 19:27:15 -04:00
Update rubocop to 0.41.2 https://github.com/bbatsov/rubocop/blob/v0.41.2/CHANGELOG.md 2016-06-29 12:00:22 -04:00			`inherit_from: .rubocop_todo.yml`
Inline RSpec/FilePath rubocop rule Moves RSpec/FilePath cop from gitlab-styles, so we can specify filepaths to ignore without hardcoding them in the gem. 2018-10-09 13:18:53 -04:00			`require:`
			`- ./rubocop/rubocop`
			`- rubocop-rspec`
Update rubocop to 0.41.2 https://github.com/bbatsov/rubocop/blob/v0.41.2/CHANGELOG.md 2016-06-29 12:00:22 -04:00
Update Rubocop from 0.35.1 to 0.38.0. Discussed in #14233. See [their releases](https://github.com/bbatsov/rubocop/releases) for more info. Changes: - Enable DisplayCopNames for lint output. - Default behavior for `Alias` changed, set to enforce `prefer_alias_method`. - Enabling Rails cops changed to new syntax. - Remove StyleGuides and move Descriptions to comments. - Add missing cops. - Add TODOs for cops that should be enabled in the future. - Set TargetRubyVersion to 2.1. 2016-03-20 22:49:12 -04:00			`AllCops:`
Update specs to rails5 format Updates specs to use new rails5 format. The old format: `get :show, { some: params }, { some: headers }` The new format: `get :show, params: { some: params }, headers: { some: headers }` 2018-12-17 17:52:17 -05:00			`TargetRailsVersion: 5.0`
Update Rubocop from 0.35.1 to 0.38.0. Discussed in #14233. See [their releases](https://github.com/bbatsov/rubocop/releases) for more info. Changes: - Enable DisplayCopNames for lint output. - Default behavior for `Alias` changed, set to enforce `prefer_alias_method`. - Enabling Rails cops changed to new syntax. - Remove StyleGuides and move Descriptions to comments. - Add missing cops. - Add TODOs for cops that should be enabled in the future. - Set TargetRubyVersion to 2.1. 2016-03-20 22:49:12 -04:00			`Exclude:`
			`- 'vendor/*/'`
ignore node_modules in rubocop 2017-02-02 13:40:49 -05:00			`- 'node_modules/*/'`
Enable RuboCop for migrations Migrations shouldn't fail RuboCop checks - especially lint checks, such as the nested method check. To avoid changing code in existing migrations, add the magic comment to the top of each of them to skip that file. 2016-06-09 08:39:16 -04:00			`- 'db/fixtures/*/'`
Enable rubocop for db/*/ and ee/db/*/ 2018-07-25 04:59:23 -04:00			`- 'db/schema.rb'`
			`- 'ee/db/geo/schema.rb'`
Update Rubocop from 0.35.1 to 0.38.0. Discussed in #14233. See [their releases](https://github.com/bbatsov/rubocop/releases) for more info. Changes: - Enable DisplayCopNames for lint output. - Default behavior for `Alias` changed, set to enforce `prefer_alias_method`. - Enabling Rails cops changed to new syntax. - Remove StyleGuides and move Descriptions to comments. - Add missing cops. - Add TODOs for cops that should be enabled in the future. - Set TargetRubyVersion to 2.1. 2016-03-20 22:49:12 -04:00			`- 'tmp/*/'`
			`- 'bin/*/'`
Updated Rubocop for generator_templates/ 2016-05-19 16:32:07 -04:00			`- 'generator_templates/*/'`
Ignore builds dir when run rubocop check Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2017-02-28 07:13:01 -05:00			`- 'builds/*/'`
Exclude plugins dir from rubocop and codeclimate config Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> 2018-02-26 10:33:38 -05:00			`- 'plugins/*/'`
Cache rubocop cache for CI 2018-01-23 10:42:58 -05:00			`CacheRootDirectory: tmp`
Update Rubocop from 0.35.1 to 0.38.0. Discussed in #14233. See [their releases](https://github.com/bbatsov/rubocop/releases) for more info. Changes: - Enable DisplayCopNames for lint output. - Default behavior for `Alias` changed, set to enforce `prefer_alias_method`. - Enabling Rails cops changed to new syntax. - Remove StyleGuides and move Descriptions to comments. - Add missing cops. - Add TODOs for cops that should be enabled in the future. - Set TargetRubyVersion to 2.1. 2016-03-20 22:49:12 -04:00
Port some RuboCop and doc changes from EE Signed-off-by: Rémy Coutable <remy@rymai.me> 2018-02-13 09:41:47 -05: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/*/'`

Explicitly disable the Style/SafeNavigation cop Signed-off-by: Rémy Coutable <remy@rymai.me> 2018-08-10 11:17:08 -04:00			`# TODO: Move this to gitlab-styles`
			`Style/SafeNavigation:`
			`Enabled: false`

Check frozen string in style builds 2018-09-28 05:43:07 -04:00			`# Frozen String Literal`
			`Style/FrozenStringLiteralComment:`
			`Enabled: true`
			`Exclude:`
			`- 'config.ru'`
			`- 'Dangerfile'`
			`- 'Gemfile'`
			`- 'Rakefile'`
			`- 'app/views/*/'`
			`- 'config/*/'`
			`- 'danger/*/'`
			`- 'db/*/'`
			`- 'ee/*/'`
Enable even more frozen string in lib/*/.rb Enables frozen string for the following files: * lib/generators/*/.rb * lib/gitaly/*/.rb * lib/google_api/*/.rb * lib/haml_lint/*/.rb * lib/json_web_token/*/.rb * lib/mattermost/*/.rb * lib/microsoft_teams/*/.rb * lib/object_storage/*/.rb * lib/omni_auth/*/.rb * lib/peek/*/.rb * lib/rouge/*/.rb * lib/rspec_flaky/*/.rb * lib/system_check/*/.rb Partially addresses #47424. 2018-10-08 10:50:39 -04:00			`- 'lib/tasks/*/'`
Check frozen string in style builds 2018-09-28 05:43:07 -04:00			`- 'qa/*/'`
			`- 'rubocop/*/'`
			`- 'scripts/*/'`
			`- 'spec/*/'`

Inline RSpec/FilePath rubocop rule Moves RSpec/FilePath cop from gitlab-styles, so we can specify filepaths to ignore without hardcoding them in the gem. 2018-10-09 13:18:53 -04:00			`RSpec/FilePath:`
			`Exclude:`
			`- 'qa/*/'`
			`- 'spec/javascripts/fixtures/*'`
			`- 'ee/spec/javascripts/fixtures/*'`
			`- 'spec/requests/api/v3/*'`

[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00			`Naming/FileName:`
			`ExpectMatchingDefinition: true`
			`Exclude:`
Enable rubocop for db/*/ and ee/db/*/ 2018-07-25 04:59:23 -04:00			`- 'db/*/'`
			`- 'ee/db/*/'`
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00			`- 'spec/*/'`
			`- 'features/*/'`
			`- 'ee/spec/*/'`
			`- 'qa/spec/*/'`
			`- 'qa/qa/specs/*/'`
			`- 'qa/bin/*'`
			`- 'config/*/'`
Put EE routes in EE files under EE directories 2018-10-15 09:59:00 -04:00			`- 'ee/config/*/'`
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00			`- 'lib/generators/*/'`
Move N_ calls into separate files These are dynamic translations, so has to be marked explicitly using `N_`, but they are not used in runtime, so can exist in separate file. https://github.com/grosser/gettext_i18n_rails#unfound-translations-with-rake-gettextfind 2018-08-08 02:38:39 -04:00			`- 'locale/unfound_translations.rb'`
			`- 'ee/locale/unfound_translations.rb'`
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00			`- 'ee/lib/generators/*/'`
Rename SSL to TLS 2018-10-25 04:11:19 -04:00			`- 'qa/qa/scenario/test/integration/ldap_no_tls.rb'`
			`- 'qa/qa/scenario/test/integration/ldap_tls.rb'`
Fix rubocop issues 2018-10-24 09:17:29 -04:00
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00			`IgnoreExecutableScripts: true`
			`AllowedAcronyms:`
			`- EE`
			`- JSON`
			`- LDAP`
Initial commit Use ACCEPT_INSECURE_CERTS env var and fix step Simplify saml signin Fix rubo cop offence Add missing # frozen_string_literal: true 2018-10-10 11:02:43 -04:00			`- SAML`
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05: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`
Adds inter-service OpenTracing propagation This change allows the GitLab rails and sidekiq components to receive tracing spans from upstream services such as Workhorse and pass these spans on to downstream services including Gitaly and Sidekiq. This change will also emit traces for incoming and outgoing requests using the propagated trace information. This will allow operators and engineers to view traces across the Workhorse, GitLab Rails, Sidekiq and Gitaly components. Additional intra-service instrumentation will be added in future changes. 2019-01-07 05:40:54 -05:00			`- GRPC`
[CE] Add Naming/FileName rule checking expected class/module per filename 2018-03-08 07:56:54 -05:00
Correct Gitlab Capitalization in code files 2018-09-21 08:05:37 -04:00			`# GitLab ###################################################################`
Move ModuleWithInstanceVariables to Gitlab namespace And use .rubocop.yml to exclude paths we don't care, rather than using the cop itself to exclude. 2017-11-22 02:50:36 -05:00
			`Gitlab/ModuleWithInstanceVariables:`
			`Enable: true`
			`Exclude:`
			`# We ignore Rails helpers right now because it's hard to workaround it`
Backport changes from EE 2017-12-15 06:37:57 -05:00			`- app/helpers/*/_helper.rb`
Require our own custom cops; Remove missing cops Also try to use the same config from EE 2017-12-26 03:30:36 -05:00			`- ee/app/helpers/*/_helper.rb`
Move ModuleWithInstanceVariables to Gitlab namespace And use .rubocop.yml to exclude paths we don't care, rather than using the cop itself to exclude. 2017-11-22 02:50:36 -05:00			`# We ignore Rails mailers right now because it's hard to workaround it`
Backport changes from EE 2017-12-15 06:37:57 -05:00			`- app/mailers/emails/*/.rb`
Require our own custom cops; Remove missing cops Also try to use the same config from EE 2017-12-26 03:30:36 -05:00			`- ee//emails//*.rb`
Move ModuleWithInstanceVariables to Gitlab namespace And use .rubocop.yml to exclude paths we don't care, rather than using the cop itself to exclude. 2017-11-22 02:50:36 -05:00			`# We ignore spec helpers because it usually doesn't matter`
			`- spec/support/*/.rb`
			`- features/steps/*/.rb`
Port some RuboCop and doc changes from EE Signed-off-by: Rémy Coutable <remy@rymai.me> 2018-02-13 09:41:47 -05:00
Merge branch 'fj-15329-services-callbacks-ssrf' into 'security-10-6' Server Side Request Forgery in Services and Web Hooks See merge request gitlab/gitlabhq!2337 2018-03-13 18:38:25 -04:00			`Gitlab/HTTParty:`
			`Enabled: true`

Port some RuboCop and doc changes from EE Signed-off-by: Rémy Coutable <remy@rymai.me> 2018-02-13 09:41:47 -05:00			`GitlabSecurity/PublicSend:`
			`Enabled: true`
			`Exclude:`
			`- 'config/*/'`
			`- 'db/*/'`
			`- 'features/*/'`
			`- 'lib/*/.rake'`
			`- 'qa/*/'`
			`- 'spec/*/'`
			`- 'ee/db/*/'`
			`- 'ee/lib/*/.rake'`
			`- 'ee/spec/*/'`
Added Cop for injecting EE modules This Cop enforces the rule that injecting EE modules (using prepend, include, or extend) is done by placing the injection on the last line of a file, instead of somewhere in the middle. By placing these lines at the very end, merge conflicts will not happen. 2018-12-13 09:46:01 -05:00
			`Cop/InjectEnterpriseEditionModule:`
			`Enabled: true`
			`Exclude:`
			`- 'spec/*/'`
			`- 'ee/spec/*/'`
Adds the Rubocop ReturnNil cop This style change enforces `return if ...` instead of `return nil if ...` to save maintainers a few minor review points 2019-02-08 07:19:53 -05:00
			`Style/ReturnNil:`
			`Enabled: true`