.rubocop.yml

# yaml-language-server: $schema=https://www.rubyschema.org/rubocop.json
---
# Explicitly disable pending cops for now. This is the default behaviour but
# this avoids a large warning every time we run it.
# Stop RuboCop nagging about rubocop-rake.
# Ensure that RuboCop validates according to the lowest version of Ruby that we support.
AllCops:
  Exclude:
    - "bin/*"
  NewCops: enable
  SuggestExtensions: false
  TargetRubyVersion: 3.2

# Whether MFA is required or not should be left to the token configuration.
Gemspec/RequireMFA:
  Enabled: false

# Don't require this extra line break, it can be excessive.
Layout/EmptyLineAfterGuardClause:
  Enabled: false

# Don't leave complex assignment values hanging off to the right.
Layout/EndAlignment:
  EnforcedStyleAlignWith: variable

Layout/FirstArrayElementLineBreak:
  Enabled: true

Layout/FirstHashElementLineBreak:
  Enabled: true

Layout/FirstMethodArgumentLineBreak:
  Enabled: true

Layout/FirstMethodParameterLineBreak:
  Enabled: true

# Set a reasonable line length; rely on other cops to correct long lines.
Layout/LineLength:
  AllowedPatterns:
    - "^\\s*#.*$"
    - ^require(_relative)?
    - "Orb::Internal::Type::BaseModel$"
    - "^\\s*[A-Z0-9_]+ = :"
    - "Orb::(Models|Resources|Test)::"
  Max: 110

Layout/MultilineArrayLineBreaks:
  Enabled: true

# Start the assignment on the same line variable is mentioned.
Layout/MultilineAssignmentLayout:
  EnforcedStyle: same_line

Layout/MultilineHashKeyLineBreaks:
  Enabled: true

Layout/MultilineMethodArgumentLineBreaks:
  Enabled: true

Layout/MultilineMethodParameterLineBreaks:
  Enabled: true

# Prefer compact hash literals.
Layout/SpaceInsideHashLiteralBraces:
  EnforcedStyle: no_space
  Exclude:
    - "**/*.rbi"

Lint/BooleanSymbol:
  Enabled: false

# This option occasionally mangles identifier names
Lint/DeprecatedConstants:
  Exclude:
    - "**/*.rbi"

# We use pattern assertion in tests to ensure correctness.
Lint/DuplicateMatchPattern:
  Exclude:
    - "test/**/*"

# Fairly useful in tests for pattern assertions.
Lint/EmptyInPattern:
  Exclude:
    - "test/**/*"

Lint/MissingCopEnableDirective:
  Exclude:
    - "examples/**/*.rb"

Lint/MissingSuper:
  Exclude:
    - "**/*.rbi"

Lint/SymbolConversion:
  Exclude:
    - "**/*.rbi"

# Disabled for safety reasons, this option changes code semantics.
Lint/UnusedMethodArgument:
  AutoCorrect: false

# This option is prone to causing accidental bugs.
Lint/UselessAssignment:
  AutoCorrect: false
  Exclude:
    - "examples/**/*.rb"

Metrics/AbcSize:
  Enabled: false

Metrics/BlockLength:
  AllowedPatterns:
    - assert_pattern
    - type_alias
    - define_sorbet_constant!
  Exclude:
    - "**/*.rbi"

Metrics/ClassLength:
  Enabled: false

Metrics/CollectionLiteralLength:
  Exclude:
    - "test/**/*"

Metrics/CyclomaticComplexity:
  Enabled: false

Metrics/MethodLength:
  Enabled: false

Metrics/ModuleLength:
  Enabled: false

Metrics/ParameterLists:
  Enabled: false

Metrics/PerceivedComplexity:
  Enabled: false

Naming/AccessorMethodName:
  Enabled: false

# Need to preserve block identifier for documentation.
Naming/BlockForwarding:
  Enabled: false

# Underscores are generally useful for disambiguation.
Naming/ClassAndModuleCamelCase:
  Enabled: false

Naming/MethodParameterName:
  Enabled: false

Naming/PredicatePrefix:
  Exclude:
    - "**/*.rbi"

Naming/VariableNumber:
  Enabled: false

# Nothing wrong with inline private methods.
Style/AccessModifierDeclarations:
  Enabled: false

Style/AccessorGrouping:
  Exclude:
    - "**/*.rbi"

# Behaviour of alias_method is more predictable.
Style/Alias:
  EnforcedStyle: prefer_alias_method

# And/or have confusing precedence, avoid them.
Style/AndOr:
  EnforcedStyle: always

Style/ArgumentsForwarding:
  Enabled: false

Style/BisectedAttrAccessor:
  Exclude:
    - "**/*.rbi"

# We prefer nested modules in lib/, but are currently using compact style for tests.
Style/ClassAndModuleChildren:
  Exclude:
    - "test/**/*"

Style/CommentAnnotation:
  Enabled: false

# We should go back and add these docs, but ignore for now.
Style/Documentation:
  Enabled: false

# Allow explicit empty elses, for clarity.
Style/EmptyElse:
  Enabled: false

Style/EmptyMethod:
  Exclude:
    - "**/*.rbi"

# We commonly use ENV['KEY'], it's OK.
Style/FetchEnvVar:
  Enabled: false

# Just to be safe, ensure nobody is mutating our internal strings.
Style/FrozenStringLiteralComment:
  EnforcedStyle: always
  Exclude:
    - "**/*.rbi"

# Nothing wrong with clear if statements.
Style/IfUnlessModifier:
  Enabled: false

# Rubocop is pretty bad about mangling single line lambdas.
Style/Lambda:
  Enabled: false

# Prefer consistency in method calling syntax.
Style/MethodCallWithArgsParentheses:
  AllowedMethods:
    - raise
  Enabled: true
  Exclude:
    - "**/*.gemspec"

Style/MultilineBlockChain:
  Enabled: false

# Perfectly fine.
Style/MultipleComparison:
  Enabled: false

Style/MutableConstant:
  Exclude:
    - "**/*.rbi"

# Not all parameters should be named.
Style/NumberedParameters:
  Enabled: false

Style/NumberedParametersLimit:
  Max: 2

# Reasonable to use brackets for errors with long messages.
Style/RaiseArgs:
  Enabled: false

# Be explicit about `RuntimeError`s.
Style/RedundantException:
  Enabled: false

Style/RedundantInitialize:
  Exclude:
    - "**/*.rbi"

Style/RedundantParentheses:
  Exclude:
    - "**/*.rbi"

# Prefer slashes for regex literals.
Style/RegexpLiteral:
  EnforcedStyle: slashes

# Allow explicit ifs, especially for imperative use.
Style/SafeNavigation:
  Enabled: false

Style/SignalException:
  Exclude:
    - Rakefile
    - "**/*.rake"

# We use these sparingly, where we anticipate future branches for the
# inner conditional.
Style/SoleNestedConditional:
  Enabled: false

# Prefer double quotes so that interpolation can be easily added.
Style/StringLiterals:
  EnforcedStyle: double_quotes

# Prefer explicit symbols for clarity; you can search for `:the_symbol`.
Style/SymbolArray:
  EnforcedStyle: brackets

# This option makes examples harder to read for ruby novices.
Style/SymbolProc:
  Exclude:
    - "examples/**/*.rb"