.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/brigade/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/brigade/overcommit/tree/master/lib/overcommit/hook
#
# For a complete list of options that you can use to customize hooks, see:
# https://github.com/brigade/overcommit#configuration

PreCommit:
  BundleCheck:
    enabled: true
    description: 'Check Gemfile dependencies'
    required_executable: 'bundle'
    flags: ['check']
    install_command: 'gem install bundler'
    include:
      - 'Gemfile'
      - 'Gemfile.lock'
      - '*.gemspec'

  SlimLint:
    enabled: true
    description: 'Analyze with slim-lint'
    required_executable: 'slim-lint'
    install_command: 'gem install slim_lint'
    include: '**/*.slim'
    problem_on_unmodified_line: ignore

CommitMsg:
  MessageFormat:
    enabled: true
    description: 'Check commit message matches expected pattern'
    pattern: '\*\*Why\*\*:'
    expected_pattern_message: >
      Body of commit message must include a reason for the change.
      See our contribution guidelines:
      https://github.com/18F/identity-idp/blob/master/CONTRIBUTING.md#commit-message-style-guide
    sample_message: '**Why**: To eliminate unnecessary database calls.'
    on_fail: warn

  TextWidth:
    enabled: true
    description: 'Check text width'
    max_subject_width: 50
    max_body_width: 72