rubocop.yml

########################################################
# General
########################################################

AllCops:
  DisplayCopNames: true
  NewCops: enable
  SuggestExtensions: false
  UseCache: true
  Include:
    - Gemfile
    - Gemfile-local
    - Rakefile.rb
    - '**/*.rb'
  Exclude:
    - '**/node_modules/**/*'
    - '**/google_protobuf/**/*_pb.rb'
    - bazel-bin/**/*
    - bazel-genfiles/**/*
    - bazel-out/**/*
    - build/**/*
    - sorbet_ruby/**/*
    - src_transform_out/**/*
    - tmp/**/*
    - test/tmp/**/*
    - vendor/**/*
    # Rubocop editor extensions use --stdin [filename] --force-exclusion, which
    # only looks at the "exclude" list to determine if a file is Rubocop-able.
    # Explicitly exclude Sorbet interface files, as large ones can cause
    # Rubocop to lock up for minutes at a time!
    - 'sorbet/shims/**/*.rbi'
    # Exclude hand-written shims for any native extensions.
    - 'native/**/*.rbi'
  AllowSymlinksInCacheRootDirectory: true

Layout:
  Enabled: false

Lint/SuppressedException:
  AllowComments: true
Lint/InheritException:
  EnforcedStyle: standard_error
Lint/UnderscorePrefixedVariableName:
  AllowKeywordBlockArguments: true
Lint/UnusedBlockArgument:
  AllowUnusedKeywordArguments: true

Metrics/AbcSize:
  Enabled: false
Metrics/BlockLength:
  Enabled: false
Metrics/BlockNesting:
  Enabled: false
Metrics/ClassLength:
  Enabled: false
Metrics/CyclomaticComplexity:
  Enabled: false
Metrics/MethodLength:
  Enabled: false
Metrics/ModuleLength:
  Enabled: false
Metrics/ParameterLists:
  CountKeywordArgs: false
  Max: 10
  MaxOptionalParameters: 10
Metrics/PerceivedComplexity:
  Enabled: false

Naming/AccessorMethodName:
  Enabled: false
Naming/HeredocDelimiterNaming:
  Enabled: false
Naming/PredicateName:
  Enabled: false
Naming/RescuedExceptionsVariableName:
  Enabled: false
Naming/VariableNumber:
  Enabled: false

# Putting these in context is way better.
Style/AccessModifierDeclarations:
  EnforcedStyle: inline
# `alias_method` has better semantics than `alias`
Style/Alias:
  EnforcedStyle: prefer_alias_method
Style/AndOr:
  Enabled: true
  EnforcedStyle: always
# %{} is weirder than %q{}
Style/BarePercentLiterals:
  EnforcedStyle: percent_q
# In Ruby the default is usually what you want. Forcing you to write out the
# class leads to errors like rescuing Exception or RuntimeError.
Style/BlockDelimiters:
  Enabled: false
Style/ClassAndModuleChildren:
  Enabled: false
Style/CommentAnnotation:
  Enabled: false
Style/ConditionalAssignment:
  Enabled: false
Style/Documentation:
  Enabled: false
Style/DoubleNegation:
  Enabled: false
Style/EmptyElse:
  Enabled: false
Style/EmptyLinesAroundBody:
  Enabled: false
Style/EmptyMethod:
  Enabled: false
Style/FormatString:
  EnforcedStyle: sprintf
# Disabled for now
Style/FrozenStringLiteralComment:
  EnforcedStyle: false
Style/GuardClause:
  Enabled: false
Style/HashSyntax:
  Enabled: false
Style/IfInsideElse:
  Enabled: false
Style/IfUnlessModifier:
  Enabled: false
Style/Lambda:
  Enabled: false
Style/MethodCallWithoutArgsParentheses:
  Enabled: false
Style/MinMax:
  Enabled: false
Style/MultilineBlockChain:
  Enabled: false
Style/MultilineTernaryOperator:
  Enabled: false
Style/MultipleComparison:
  Enabled: false
Style/NegatedIf:
  Enabled: false
Style/NegatedWhile:
  Enabled: false
Style/Next:
  Enabled: false
Style/NumericPredicate:
  Enabled: false
# Consistently use {}
Style/PercentLiteralDelimiters:
  PreferredDelimiters:
    '%':  '{}'
    '%i': '{}'
    '%I': '{}'
    '%q': '{}'
    '%Q': '{}'
    '%r': '{}'
    '%s': '{}'
    '%w': '{}'
    '%W': '{}'
    '%x': '{}'
  Enabled: false
Style/PerlBackrefs:
  Enabled: false
# This is much more explicit
Style/RaiseArgs:
  EnforcedStyle: compact
Style/RedundantBegin:
  Enabled: false
Style/RedundantParentheses:
  Enabled: false
Style/RedundantSelf:
  Enabled: false
Style/RescueStandardError:
  EnforcedStyle: implicit
# If you are doing it all on one line, fine
Style/Semicolon:
  AllowAsExpressionSeparator: true
Style/SingleLineMethods:
  Enabled: false
Style/SpecialGlobalVars:
  EnforcedStyle: use_english_names
Style/StderrPuts:
  Enabled: false
Style/StringLiterals:
  Enabled: false
Style/StringLiteralsInInterpolation:
  Enabled: false
Style/SymbolArray:
  Enabled: false
Style/TernaryParentheses:
  Enabled: false
# Trailing commas help with git blame when you add new parameters
Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: consistent_comma
  Enabled: false
Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: consistent_comma
  Enabled: false
Style/TrailingUnderscoreVariable:
  Enabled: false
Style/TrivialAccessors:
  # Predicates are ok per https://github.com/bbatsov/rubocop/issues/2763
  AllowPredicates: true
  # And writers per https://github.com/bbatsov/rubocop/issues/2821
  AllowDSLWriters: true
  IgnoreClassMethods: true
# `format` and `sprintf` are the same so we picked one. % leads to errors since we can't enforce the RHS to be an array.
Style/WhileUntilModifier:
  Enabled: false
Style/WordArray:
  Enabled: false
Style/ZeroLengthPredicate:
  Enabled: false

# From the 0.89.1 update: some of these might be nice to enable
Lint/AmbiguousBlockAssociation:
  Enabled: false
Lint/EmptyBlock:
  Enabled: false
Lint/EmptyClass:
  Enabled: false
Lint/PercentStringArray:
  Enabled: false
Lint/UnusedMethodArgument:
  Enabled: false
Lint/MissingSuper:
  Enabled: false
Lint/BinaryOperatorWithIdenticalOperands:
  Enabled: false
Lint/DeprecatedOpenSSLConstant:
  Enabled: false
Lint/DuplicateElsifCondition:
  Enabled: false
Lint/DuplicateRescueException:
  Enabled: false
Lint/EmptyConditionalBody:
  Enabled: false
Lint/FloatComparison:
  Enabled: false
Lint/MixedRegexpCaptureTypes:
  Enabled: false
Lint/OutOfRangeRegexpRef:
  Enabled: false
Lint/RaiseException:
  Enabled: false
Lint/SelfAssignment:
  Enabled: false
Lint/StructNewOverride:
  Enabled: false
Lint/TopLevelReturnWithArgument:
  Enabled: false
Lint/UnreachableLoop:
  Enabled: false
Style/AccessorGrouping:
  Enabled: false
Style/ArrayCoercion:
  Enabled: false
Style/BisectedAttrAccessor:
  Enabled: false
Style/CaseLikeIf:
  Enabled: false
Style/ExplicitBlockArgument:
  Enabled: false
Style/ExponentialNotation:
  Enabled: false
Style/GlobalStdStream:
  Enabled: false
Style/HashAsLastArrayItem:
  Enabled: false
Style/HashLikeCase:
  Enabled: false
Style/OptionalBooleanParameter:
  Enabled: false
Style/RedundantAssignment:
  Enabled: false
Style/RedundantFetchBlock:
  Enabled: false
Style/RedundantFileExtensionInRequire:
  Enabled: false
Style/RedundantRegexpCharacterClass:
  Enabled: false
Style/RedundantRegexpEscape:
  Enabled: false
Style/SingleArgumentDig:
  Enabled: false
Style/SlicingWithRange:
  Enabled: false
Style/StringConcatenation:
  Enabled: false
Lint/UriRegexp:
  Enabled: false

# From 1.26.1 Upgrade
Bundler/GemFilename:
  Enabled: false
Gemspec/RequireMFA: # new in 1.23
  Enabled: true
Lint/AmbiguousAssignment: # new in 1.7
  Enabled: true
Lint/AmbiguousOperatorPrecedence: # new in 1.21
  Enabled: false
Lint/AmbiguousRange: # new in 1.19
  Enabled: false
Lint/DeprecatedConstants: # new in 1.8
  Enabled: true
Lint/DuplicateBranch: # new in 1.3
  Enabled: false
Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
  Enabled: false
Lint/EmptyInPattern: # new in 1.16
  Enabled: true
Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
  Enabled: true
Lint/LambdaWithoutLiteralBlock: # new in 1.8
  Enabled: true
Lint/NoReturnInBeginEndBlocks: # new in 1.2
  Enabled: false
Lint/NumberedParameterAssignment: # new in 1.9
  Enabled: true
Lint/OrAssignmentToConstant: # new in 1.9
  Enabled: false
Lint/RedundantDirGlobSort: # new in 1.8
  Enabled: true
Lint/RequireRelativeSelfPath: # new in 1.22
  Enabled: true
Lint/SymbolConversion: # new in 1.9
  Enabled: false
Lint/ToEnumArguments: # new in 1.1
  Exclude:
  - 'extn/sinatra.rb'
  Enabled: true
Lint/TripleQuotes: # new in 1.9
  Enabled: false
Lint/UnexpectedBlockArity: # new in 1.5
  Enabled: false
Lint/UnmodifiedReduceAccumulator: # new in 1.1
  Enabled: true
Lint/UselessRuby2Keywords: # new in 1.23
  Enabled: false
Security/IoMethods: # new in 1.22
  Enabled: false
Style/ArgumentsForwarding: # new in 1.1
  Enabled: false
Style/CollectionCompact: # new in 1.2
  Enabled: false
Style/DocumentDynamicEvalDefinition: # new in 1.1
  Enabled: false
Style/EndlessMethod: # new in 1.8
  Enabled: true
Style/FileRead: # new in 1.24
  Enabled: false
Style/FileWrite: # new in 1.24
  Enabled: false
Style/HashConversion: # new in 1.10
  Enabled: false
Style/IfWithBooleanLiteralBranches: # new in 1.9
  Enabled: false
Style/InPatternThen: # new in 1.16
  Enabled: true
Style/MapToHash: # new in 1.24
  Enabled: false
Style/MultilineInPatternThen: # new in 1.16
  Enabled: true
Style/NegatedIfElseCondition: # new in 1.2
  Enabled: false
Style/NilLambda: # new in 1.3
  Enabled: false
Style/NumberedParameters: # new in 1.22
  Enabled: true
Style/NumberedParametersLimit: # new in 1.22
  Enabled: false
Style/OpenStructUse: # new in 1.23
  Enabled: true
Style/QuotedSymbols: # new in 1.16
  Enabled: false
Style/RedundantArgument: # new in 1.4
  Enabled: false
Style/RedundantSelfAssignmentBranch: # new in 1.19
  Enabled: false
Style/SelectByRegexp: # new in 1.22
  Enabled: false
Style/StringChars: # new in 1.12
  Enabled: false
Style/SwapValues: # new in 1.1
  Enabled: true
Style/KeywordParametersOrder: # new in 0.90
  Enabled: false
Style/ClassEqualityComparison: # new in 0.93
  Enabled: false
Lint/ConstantDefinitionInBlock: # new in 0.91
  Enabled: false
Lint/UselessMethodDefinition: # new in 0.90
  Enabled: false
Style/CombinableLoops: # new in 0.90
  Enabled: false
Lint/RedundantSafeNavigation: # new in 0.93
  Enabled: false
Lint/DuplicateRequire: # new in 0.90
  Enabled: false
Style/RedundantSelfAssignment: # new in 0.90
  Enabled: false
Lint/UselessTimes: # new in 0.91
  Enabled: false
Style/SoleNestedConditional: # Marked as enabled (from pending) after 0.89
  Enabled: false
Style/SymbolProc:
  Enabled: true
Lint/ElseLayout:
  Enabled: false
Lint/DuplicateCaseCondition:
  Enabled: true
Layout/LeadingCommentSpace:
  Enabled: true
Style/MultilineWhenThen:
  Enabled: false

# 1.32.1 Upgrade
Gemspec/DeprecatedAttributeAssignment: # Replaces Gemspec/DateAssignment
  Enabled: true
Lint/ConstantOverwrittenInRescue: # new in 1.31
  Enabled: false # rubyfmt
Lint/NonAtomicFileOperation: # new in 1.31
  Enabled: false
Lint/RefinementImportMethods: # new in 1.27
  Enabled: true
Security/CompoundHash: # new in 1.28
  Enabled: false
Style/EnvHome: # new in 1.29
  Enabled: false
Style/FetchEnvVar: # new in 1.28
  Enabled: false
Style/MapCompactWithConditionalBlock: # new in 1.30
  Enabled: false
Style/NestedFileDirname: # new in 1.26
  Enabled: true
Style/ObjectThen: # new in 1.28
  Enabled: false
Style/RedundantInitialize: # new in 1.27
  Enabled: false
Style/RedundantCondition:
  Enabled: false
Lint/EmptyWhen:
  Enabled: false

# 1.56.1 Upgrade
Gemspec/DevelopmentDependencies: # new in 1.44
  Enabled: true
Lint/DuplicateMagicComment: # new in 1.37
  Enabled: true
Lint/DuplicateMatchPattern: # new in 1.50
  Enabled: true
Lint/MixedCaseRange: # new in 1.53
  Enabled: true
Lint/RedundantRegexpQuantifiers: # new in 1.53
  Enabled: true
Lint/RequireRangeParentheses: # new in 1.32
  Enabled: true
Lint/UselessRescue: # new in 1.43
  Enabled: true
Metrics/CollectionLiteralLength: # new in 1.47
  Enabled: false
Style/ArrayIntersect: # new in 1.40
  Enabled: true
Style/ComparableClamp: # new in 1.44
  Enabled: false
Style/EachForSimpleLoop:
  Enabled: false
Style/ConcatArrayLiterals: # new in 1.41
  Enabled: false
Style/DataInheritance: # new in 1.49
  Enabled: true
Style/DirEmpty: # new in 1.48
  Enabled: true
Style/EmptyHeredoc: # new in 1.32
  Enabled: true
Style/ExactRegexpMatch: # new in 1.51
  Enabled: true
Style/FileEmpty: # new in 1.48
  Enabled: true
Style/MagicCommentFormat: # new in 1.35
  Enabled: true
Style/MapToSet: # new in 1.42
  Enabled: true
Style/MinMaxComparison: # new in 1.42
  Enabled: true
Style/OperatorMethodCall: # new in 1.37
  Enabled: false
Style/RedundantReturn:
  Enabled: false
Style/RedundantArrayConstructor: # new in 1.52
  Enabled: true
Style/RedundantConstantBase: # new in 1.40
  Enabled: false
Style/RedundantCurrentDirectoryInPath: # new in 1.53
  Enabled: false
Style/RedundantDoubleSplatHashBraces: # new in 1.41
  Enabled: false
Style/RedundantEach: # new in 1.38
  Enabled: true
Style/RedundantFilterChain: # new in 1.52
  Enabled: true
Style/RedundantHeredocDelimiterQuotes: # new in 1.45
  Enabled: true
Style/RedundantLineContinuation: # new in 1.49
  Enabled: true
Style/RedundantRegexpArgument: # new in 1.53
  Enabled: true
Style/RedundantRegexpConstructor: # new in 1.52
  Enabled: true
Style/RedundantStringEscape: # new in 1.37
  Enabled: false
Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
  Enabled: false
Style/YAMLFileRead: # new in 1.53
  Enabled: true

# Ruby 3.1 upgrade
# Redunant freezes are fine.
Style/RedundantFreeze:
  Enabled: false
Naming/BlockForwarding:
  Enabled: false
Style/HashExcept:
  Enabled: false
Style/SingleLineDoEndBlock: # new in 1.57
  Enabled: true

############################################################
# Open Source Customization
#
# Open source cops which are specially customized
############################################################

# Minitest/AssertEmptyLiteral:
#   Enabled: false
# Minitest/AssertNil:
#   Enabled: false
# Minitest/AssertTruthy:
#   Enabled: false
# Minitest/RefuteFalse:
#   Enabled: false
# Minitest/AssertInDelta:
#   Enabled: false
# Minitest/AssertionInLifecycleHook:
#   Enabled: true
# Minitest/AssertKindOf:
#   Enabled: true
# Minitest/AssertOutput:
#   Enabled: true
# Minitest/AssertPathExists:
#   Enabled: false
# Minitest/AssertSilent:
#   Enabled: true
# Minitest/AssertWithExpectedArgument:
#   Enabled: true
# Minitest/LiteralAsActualArgument:
#   Enabled: false
# Minitest/MultipleAssertions:
#   Enabled: false
# Minitest/RefuteInDelta:
#   Enabled: true
# Minitest/RefuteKindOf:
#   Enabled: true
# Minitest/RefutePathExists:
#   Enabled: false
# Minitest/TestMethodName:
#   Enabled: false
# Minitest/UnreachableAssertion:
#   Enabled: false
# Minitest/UnspecifiedException:
#   Enabled: false
# Minitest/RefuteMatch:
#   Enabled: false
# Minitest/AssertMatch:
#   Enabled: false
# Minitest/RefuteNil:
#   Enabled: true
# Minitest/RefuteIncludes:
#   Enabled: false
# Minitest/AssertIncludes:
#   Enabled: false
# Minitest/AssertRespondTo:
#   Enabled: false
#
# Performance/StartWith:
#   Enabled: false
# Performance/EndWith:
#   Enabled: false
# Performance/TimesMap:
#   Enabled: false
# Performance/AncestorsInclude:
#   Enabled: true
# Performance/BigDecimalWithNumericArgument:
#   Enabled: false
# Performance/BlockGivenWithExplicitBlock:
#   Enabled: false
# Performance/CollectionLiteralInLoop:
#   Enabled: false
# Performance/ConcurrentMonotonicTime:
#   Enabled: true
# Performance/ConstantRegexp:
#   Enabled: false
# # Disabled because there's no safe autocorrection.
# # See the following example:
# # [true, false, nil].compact              #=> [true, false]
# # [true, false, nil].filter_map(&:itself) #=> [true]
# Performance/MapCompact:
#   Enabled: false
# Performance/MethodObjectAsBlock:
#   Enabled: false
# Performance/RedundantEqualityComparisonBlock:
#   Enabled: false
# Performance/RedundantSortBlock:
#   Enabled: true
# Performance/RedundantSplitRegexpArgument:
#   Enabled: false
# Performance/RedundantStringChars:
#   Enabled: false
# Performance/ReverseFirst:
#   Enabled: false
# Performance/SortReverse:
#   Enabled: true
# Performance/Squeeze:
#   Enabled: false
# Performance/StringIdentifierArgument:
#   Enabled: false
# Performance/StringInclude:
#   Enabled: false
# Performance/Sum:
#   Enabled: false
# Performance/DeletePrefix:
#   Enabled: false
# Performance/DeleteSuffix:
#   Enabled: false
# Performance/Detect:
#   Enabled: false
# Performance/Count:
#   Enabled: false
# Performance/RedundantBlockCall:
#   Enabled: false
# # If you have more than 1, you can use merge! if you want
# Performance/RedundantMerge:
#   MaxKeyValuePairs: 1