.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
#
# Uncomment the following lines to make the configuration take effect.
PreCommit:
  RuboCop:
    enabled: true
    on_warn: fail       # Treat all warnings as failures
    require_files: true # Only check filed changed in the commit

  TrailingWhitespace:
    enabled: true
    exclude:
      - "**/db/structure.sql" # Ignore trailing whitespace in generated files
      - "**/*.md"

# 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

CommitMsg:
  # we use
  CapitalizedSubject:
    enabled: false

  TextWidth:
    enabled: true
    max_subject_width: 72

  MessageFormat:
    enabled: true
    pattern: '^[asset|clean|cleanup|config|db|doc|enhance|feat|fix|fixup!|hotfix|lint|locale|migrate|notify|optim|quality|readability|recode|refact|revert|reword|security|style|system|tasks|test|tests|typo|update|upgrade|wip|wording]+[\([a-z-]+\)]*:'
    expected_pattern_message: '<type>(<scope>): <subject>'
    sample_message: 'feat(controller): add a before_filter check for quality'