.overcommit.yml

# Use this file to configure the Overcommit hooks you wish to use. This will
# extend the default configuration defined in:
# https://github.com/sds/overcommit/blob/master/config/default.yml
#
# At the topmost level of this YAML file is a key representing type of hook
# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
# customize each hook, such as whether to only run it on certain files (via
# `include`), whether to only display output if it fails (via `quiet`), etc.
#
# For a complete list of hooks, see:
# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
#
# For a complete list of options that you can use to customize hooks, see:
# https://github.com/sds/overcommit#configuration
#
# Uncomment the following lines to make the configuration take effect.

PreCommit:
  RuboCop:
    enabled: true
    on_warn: fail # Treat all warnings as failures
    command: ['rubocop', '--require', 'rubocop-gitlab-security']
  ForbiddenBranches:
    enabled: true
    branch_patterns: ['main']
  Fasterer:
    enabled: true
    on_warn: fail
    exclude:
      - 'vendor/**/*.rb'
      - 'db/schema.rb'
  BundleCheck:
    enabled: true
CommitMsg:
  CapitalizedSubject:
    enabled: false
  MessageFormat:
    enabled: true
    description: 'Check commit message matches expected pattern'
    pattern: '^((feat|fix|refactor|test|chore|perf|wip): (.+))'
    expected_pattern_message: '<Type>: <Commit Message Description>'
    sample_message: 'feat: refactored onboarding flow, allowed types: [feat, fix, refactor, test, chore, pref, wip]'
  TextWidth:
    enabled: true
    description: 'Check text width'
    max_subject_width: 100
    max_body_width: 300
#
#PostCheckout:
#  ALL: # Special hook name that customizes all hooks of this type
#    quiet: true # Change all post-checkout hooks to only display output on failure
#
#  IndexTags:
#    enabled: true # Generate a tags file with `ctags` each time HEAD changes