.rubocop.yml

inherit_from: .rubocop_todo.yml

require:
  - rubocop/require_tools
  - rubocop-performance
  - ./rubocop/fork_usage.rb
  - ./rubocop/missing_keys_on_shared_area.rb
  - ./rubocop/is_string_usage.rb

AllCops:
  TargetRubyVersion: 2.5
  NewCops: enable
  Include:
    - '**/*.rb'
    - '**/*file'
    - '**/*.gemspec'
    - '*/lib/assets/*Template'
    - '*/lib/assets/*TemplateAndroid'
  Exclude:
    - '**/lib/assets/custom_action_template.rb'
    - './vendor/**/*'
    - '**/lib/assets/DefaultFastfileTemplate'
    - '**/lib/assets/MatchfileTemplate'
    - '**/spec/fixtures/broken_files/broken_file.rb'
    - '**/*.provisionprofile'

Style/MultipleComparison:
  Enabled: false

Style/PercentLiteralDelimiters:
  Enabled: false

# kind_of? is a good way to check a type
Style/ClassCheck:
  EnforcedStyle: kind_of?

Style/FrozenStringLiteralComment:
  Enabled: false

# This doesn't work with older versions of Ruby (pre 2.4.0)
Style/SafeNavigation:
  Enabled: false

# This doesn't work with older versions of Ruby (pre 2.4.0)
Performance/RegexpMatch:
  Enabled: false

# This suggests use of `tr` instead of `gsub`. While this might be more performant,
# these methods are not at all interchangeable, and behave very differently. This can
# lead to people making the substitution without considering the differences.
Performance/StringReplacement:
  Enabled: false

# .length == 0 is also good, we don't always want .zero?
Style/NumericPredicate:
  Enabled: false

# this would cause errors with long lanes
Metrics/BlockLength:
  Enabled: false

# this is a bit buggy
Metrics/ModuleLength:
  Enabled: false

# certificate_1 is an okay variable name
Naming/VariableNumber:
  Enabled: false

# This is used a lot across the fastlane code base for config files
Style/MissingRespondToMissing:
  Enabled: false

# This rule isn't useful, lots of discussion happening around it also
# e.g. https://github.com/bbatsov/rubocop/issues/2338
Style/MultilineBlockChain:
  Enabled: false

#
#   File.chmod(0777, f)
#
# is easier to read than
#
#   File.chmod(0o777, f)
#
Style/NumericLiteralPrefix:
  Enabled: false

#
# command = (!clean_expired.nil? || !clean_pattern.nil?) ? CLEANUP : LIST
#
# is easier to read than
#
# command = !clean_expired.nil? || !clean_pattern.nil? ? CLEANUP : LIST
#
Style/TernaryParentheses:
  Enabled: false

# sometimes it is useful to have those empty methods
Style/EmptyMethod:
  Enabled: false

# specs sometimes have useless assignments, which is fine
Lint/UselessAssignment:
  Exclude:
    - '**/spec/**/*'

# In specs requires are done automatically
Require/MissingRequireStatement:
  Exclude:
    - '**/spec/**/*.rb'
    - '**/spec_helper.rb'
    - 'spaceship/lib/spaceship/babosa_fix.rb'
    - 'fastlane_core/lib/fastlane_core/ui/disable_colors.rb'
    - '**/Fastfile'
    - '**/*.gemspec'
    - 'rakelib/**/*'
    - '**/*.rake'
    - '**/Rakefile'
    - 'fastlane/**/*' # TODO: remove
    - 'supply/**/*' # TODO: remove

# We could potentially enable the 2 below:
Layout/FirstHashElementIndentation:
  Enabled: false

Layout/HashAlignment:
  Enabled: false

# HoundCI doesn't like this rule
Layout/DotPosition:
  Enabled: false

# We allow !! as it's an easy way to convert to boolean
Style/DoubleNegation:
  Enabled: false

# Prevent to replace [] into %i
Style/SymbolArray:
  Enabled: false

# We still support Ruby 2.0.0
Layout/HeredocIndentation:
  Enabled: false

# This cop would not work fine with rspec
Style/MixinGrouping:
  Exclude:
    - '**/spec/**/*'

# Sometimes we allow a rescue block that doesn't contain code
Lint/SuppressedException:
  Enabled: false

# Cop supports --auto-correct.
Lint/UnusedBlockArgument:
  Enabled: false

Lint/AmbiguousBlockAssociation:
  Enabled: false

# Needed for $verbose
Style/GlobalVars:
  Enabled: false

# We want to allow class Fastlane::Class
Style/ClassAndModuleChildren:
  Enabled: false

# $? Exit
Style/SpecialGlobalVars:
  Enabled: false

Metrics/AbcSize:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/CyclomaticComplexity:
  Enabled: false

# The %w might be confusing for new users
Style/WordArray:
  MinSize: 19

# raise and fail are both okay
Style/SignalException:
  Enabled: false

# Better too much 'return' than one missing
Style/RedundantReturn:
  Enabled: false

# Having if in the same line might not always be good
Style/IfUnlessModifier:
  Enabled: false

# and and or is okay
Style/AndOr:
  Enabled: true
  EnforcedStyle: conditionals

# Configuration parameters: CountComments.
Metrics/ClassLength:
  Max: 320


# Configuration parameters: AllowURI, URISchemes.
Layout/LineLength:
  Max: 370

# Configuration parameters: CountKeywordArgs.
Metrics/ParameterLists:
  Max: 17

# Sometimes it's easier to read without guards
Style/GuardClause:
  Enabled: false

# We allow both " and '
Style/StringLiterals:
  Enabled: false

# something = if something_else
# that's confusing
Style/ConditionalAssignment:
  Enabled: false

# Better to have too much self than missing a self
Style/RedundantSelf:
  Enabled: false

# e.g.
# def self.is_supported?(platform)
# we may never use `platform`
Lint/UnusedMethodArgument:
  Enabled: false

# the let(:key) { ... }
Lint/ParenthesesAsGroupedExpression:
  Exclude:
    - '**/spec/**/*'

# This would reject is_ in front of methods
# We use `is_supported?` everywhere already
Naming/PredicateName:
  Enabled: false

# We allow the $
Style/PerlBackrefs:
  Enabled: false

# Disable '+ should be surrounded with a single space' for xcodebuild_spec.rb
Layout/SpaceAroundOperators:
  Exclude:
    - '**/spec/actions_specs/xcodebuild_spec.rb'

# They have not to be snake_case
Naming/FileName:
  Exclude:
    - '**/Dangerfile'
    - '**/Brewfile'
    - '**/Gemfile'
    - '**/Podfile'
    - '**/Rakefile'
    - '**/Fastfile'
    - '**/Deliverfile'
    - '**/Snapfile'
    - '**/Pluginfile'
    - '**/*.gemspec'

# We're not there yet
Style/Documentation:
  Enabled: false

# Added after upgrade to 0.38.0
Style/MutableConstant:
  Enabled: false

# length > 0 is good
Style/ZeroLengthPredicate:
  Enabled: false

# Adds complexity
Style/IfInsideElse:
  Enabled: false

# Sometimes we just want to 'collect'
Style/CollectionMethods:
  Enabled: false

# Check whether fork is handled correctly on all platforms
CrossPlatform/ForkUsage:
  Exclude:
    - '**/plugins/template/**/*'

Lint/IsStringUsage:
  Include:
    - 'cert/**/*'
    - 'deliver/**/*'
    - 'fastlane/**/*'
    - 'gym/**/*'
    - 'match/**/*'
    - 'precheck/**/*'
    - 'screengrab/**/*'
    - 'supply/**/*'

# ( ) for method calls
Style/MethodCallWithArgsParentheses:
  Enabled: true
  IgnoredMethods:
    - 'require'
    - 'require_relative'
    - 'fastlane_require'
    - 'gem'
    - 'program'
    - 'command'
    - 'raise'
    - 'attr_accessor'
    - 'attr_reader'
    - 'desc'
    - 'lane'
    - 'private_lane'
    - 'platform'
    # rspec tests code below
    - 'to'
    - 'not_to'
    - 'describe'
    - 'it'
    - 'be'
    - 'context'
    - 'before'
    - 'after'