.rubocop.yml

# Ruby linting configuration.
# See https://github.com/styleguide/ruby for the Ruby style guide

# We only worry about two kinds of issues: 'error' and anything less than that.
# Error is not about severity, but about taste. Simple style choices that
# never have a great excuse to be broken, such as 1.9 JSON-like hash syntax,
# are errors. Choices that tend to have good exceptions in practice, such as
# line length, are warnings.

# If you'd like to make changes, a full list of available issues is at
#   https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
#
# A list of configurable issues is at:
#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
#
# If you disable a check, document why.

inherit_gem:
  rubocop-github:
    - config/default.yml

require:
  - rubocop-performance

AllCops:
  TargetRubyVersion: 3.0
  Exclude:
    - 'bin/**/*'
    - 'script/**/*'
    - 'vendor/**/*'
    - 'test-site/**/*'

Layout/EndAlignment:
  Severity: error

Lint/RescueException:
  Exclude:
    - lib/pages_jekyll.rb

Lint/UnreachableCode:
  Severity: error

Lint/AmbiguousRegexpLiteral:
  Exclude:
    - 'features/step_definitions/pages_steps.rb'

Style/StringLiterals:
  EnforcedStyle: double_quotes
  Severity: error

Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes

Style/HashSyntax:
  EnforcedStyle: hash_rockets
  Severity: error

Layout/HashAlignment:
  SupportedLastArgumentHashStyles: always_ignore

Layout/ParameterAlignment:
  Enabled: false # This is usually true, but we often want to roll back to
                 # the start of a line.

Style/Attr:
  Enabled: false # We have no styleguide guidance here, and it seems to be
                 # in frequent use.

Style/ClassAndModuleChildren:
  Enabled: false # module X<\n>module Y is just as good as module X::Y.

Style/Documentation:
  Exclude:
    - !ruby/regexp /spec\/.*.rb$/
    - !ruby/regexp /features\/.*.rb$/

Metrics/ClassLength:
  Exclude:
    - !ruby/regexp /spec\/.*.rb$/
    - !ruby/regexp /features\/.*.rb$/
    - lib/github-pages/configuration.rb

Metrics/BlockLength:
  Exclude:
    - github-pages.gemspec
    - !ruby/regexp /spec\/.*.rb/

Layout/LineLength:
  Max: 90
  Severity: warning
  Exclude:
    - !ruby/regexp /spec\/.*.rb/
    - !ruby/regexp /features\/.*.rb/

Style/MultilineTernaryOperator:
  Severity: error

Style/AndOr:
  Severity: error

Layout/IndentationWidth:
  Severity: error

Metrics/MethodLength:
  CountComments: false  # count full line comments?
  Max: 20
  Severity: error
  Exclude:
    - lib/github-pages.rb  # Exclude the dependency hash method

Style/Alias:
  Enabled: false # We have no guidance on alias vs alias_method

Style/RedundantSelf:
  Enabled: false # Sometimes a self.field is a bit more clear

Style/IfUnlessModifier:
  Enabled: false

Naming/FileName: #Rubocop doesn't like the Git*H*ub namespace
  Enabled: false

Metrics/CyclomaticComplexity:
  Max: 8
Metrics/PerceivedComplexity:
  Max: 8
Metrics/ParameterLists:
  Max: 4
Metrics/AbcSize:
  Max: 20

Style/SignalException:
  EnforcedStyle: only_raise

Layout/MultilineMethodCallIndentation:
  EnforcedStyle: indented

Layout/MultilineOperationIndentation:
  EnforcedStyle: indented

Layout/FirstArgumentIndentation:
  EnforcedStyle: consistent

Layout/FirstHashElementIndentation:
  EnforcedStyle: consistent

Layout/FirstArrayElementIndentation:
  EnforcedStyle: consistent

Layout/ExtraSpacing:
  AllowForAlignment: true

Style/TrailingCommaInArrayLiteral:
  EnforcedStyleForMultiline: consistent_comma

Style/TrailingCommaInHashLiteral:
  EnforcedStyleForMultiline: consistent_comma

Style/PercentLiteralDelimiters:
  PreferredDelimiters:
    '%q': '{}'
    '%Q': '{}'
    '%r': '{}'
    '%s': '()'
    '%w': '()'
    '%W': '()'
    '%x': '()'