default.yml

# Default configuration that all Overcommit configurations inherit from.
#
# This is an opinionated list of which hooks are valuable to run and what their
# out-of-the-box settings should be.

# Where to store hook plugins specific to a repository. These are loaded in
# addition to the default hooks Overcommit comes with. The location is relative
# to the root of the repository.
plugin_directory: '.git-hooks'

# Whether to check if a hook plugin has changed since Overcommit last ran it.
# This is a defense mechanism when working with repositories which can contain
# untrusted code (e.g. when you fetch a pull request from a third party).
# See https://github.com/causes/overcommit#security for more information.
verify_plugin_signatures: true

# Hooks that are run against every commit message after a user has written it.
# These hooks are useful for enforcing policies on commit messages written for a
# project.
CommitMsg:
  ALL:
    requires_files: false
    quiet: false

  GerritChangeId:
    enabled: false
    description: 'Ensuring Gerrit Change-Id is present'
    required: true

  HardTabs:
    description: 'Checking for hard tabs'

  RussianNovel:
    description: 'Checking length of commit message'
    quiet: true

  SingleLineSubject:
    description: 'Checking subject line'

  TextWidth:
    description: 'Checking text width'
    max_subject_width: 60
    max_body_width: 72

  TrailingPeriod:
    description: 'Checking for trailing periods in subject'

# Hooks that are run after `git commit` is executed, before the commit message
# editor is displayed. These hooks are ideal for syntax checkers, linters, and
# other checks that you want to run before you allow a commit object to be
# created.
PreCommit:
  ALL:
    problem_on_unmodified_line: warn
    requires_files: true
    required: false
    quiet: false

  AuthorEmail:
    description: 'Checking author email'
    requires_files: false
    required: true
    quiet: true
    pattern: '^[^@]+@.*$'

  AuthorName:
    description: 'Checking for author name'
    requires_files: false
    required: true
    quiet: true

  BerksfileCheck:
    description: 'Checking Berksfile lock'
    required_executable: 'berks'
    flags: ['list', '--quiet']
    install_command: 'gem install berks'
    include:
      - 'Berksfile'
      - 'Berksfile.lock'

  Brakeman:
    enabled: false
    description: 'Checking for security vulnerabilities'
    required_executable: 'brakeman'
    flags: ['--exit-on-warn', '--quiet', '--summary', '--only-files']
    install_command: 'gem install brakeman'
    include:
      - '**/*.rb'

  BrokenSymlinks:
    description: 'Checking for broken symlinks'
    quiet: true

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

  ChamberSecurity:
    enabled: false
    description: 'Checking that settings have been secured with Chamber'
    required_executable: 'chamber'
    flags: ['secure', '--files']
    install_command: 'gem install chamber'
    include:
      - 'config/settings.yml'
      - 'config/settings/**/*.yml'

  CoffeeLint:
    description: 'Analyzing with coffeelint'
    required_executable: 'coffeelint'
    flags: ['--quiet']
    install_command: 'npm install -g coffeelint'
    include: '**/*.coffee'

  CssLint:
    description: 'Analyzing with csslint'
    required_executable: 'csslint'
    flags: ['--quiet', '--format=compact']
    install_command: 'npm install -g csslint'
    include: '**/*.css'

  EsLint:
    description: 'Analyzing with ESLint'
    required_executable: 'eslint'
    flags: ['--format=compact']
    install_command: 'npm install -g eslint'
    include: '**/*.js'

  GoLint:
    description: 'Analyzing with golint'
    required_executable: 'golint'
    install_command: 'go get github.com/golang/lint/golint'
    include: '**/*.go'

  HamlLint:
    description: 'Analyzing with haml-lint'
    required_executable: 'haml-lint'
    install_command: 'gem install haml-lint'
    include: '**/*.haml'

  HardTabs:
    description: 'Checking for hard tabs'
    quiet: true
    required_executable: 'grep'
    flags: ['-IHn', "\t"]
    exclude:
      - '**/*.go'
      - '**/Makefile'
      - '.gitmodules'

  ImageOptim:
    description: 'Checking for optimizable images'
    include:
      - '**/*.gif'
      - '**/*.jpg'
      - '**/*.jpeg'
      - '**/*.png'

  JavaCheckstyle:
    description: 'Analyzing with checkstyle'
    required_executable: 'checkstyle'
    flags: ['-c', '/sun_checks.xml']
    include: '**/*.java'

  Jscs:
    description: 'Analyzing with JSCS'
    required_executable: 'jscs'
    flags: ['--reporter=inline', '--verbose']
    install_command: 'npm install -g jscs'
    include: '**/*.js'

  JsHint:
    description: 'Analyzing with JSHint'
    required_executable: 'jshint'
    flags: ['--verbose']
    install_command: 'npm install -g jshint'
    include: '**/*.js'

  JsonSyntax:
    description: 'Validating JSON syntax'
    include: '**/*.json'

  LocalPathsInGemfile:
    description: 'Checking for local paths in Gemfile'
    required_executable: 'grep'
    flags: ['-IHnE', '^[^#]*((\bpath:)|(:path\s*=>))']
    include: '**/Gemfile'

  MergeConflicts:
    description: 'Checking for merge conflicts'
    quiet: true
    required_executable: 'grep'
    flags: ['-IHn', '^<<<<<<<\s']

  Pep257:
    description: 'Analyzing docstrings with pep257'
    required_executable: 'pep257'
    install_command: 'pip install pep257'
    include: '**/*.py'

  Pep8:
    enabled: false
    description: 'Analyzing with pep8'
    required_executable: 'pep8'
    install_command: 'pip install pep8'
    include: '**/*.py'

  PryBinding:
    description: 'Checking for instances of binding.pry'
    quiet: true
    include:
      - '**/*.rb'
      - '**/*.rake'

  Pyflakes:
    enabled: false
    description: 'Analyzing with pyflakes'
    required_executable: 'pyflakes'
    install_command: 'pip install pyflakes'
    include: '**/*.py'

  PythonFlake8:
    description: 'Analyzing with flake8'
    required_executable: 'flake8'
    install_command: 'pip install flake8'
    include: '**/*.py'

  RailsSchemaUpToDate:
    description: 'Checking if database schema is up to date'
    include:
      - 'db/migrate/*.rb'
      - 'db/schema.rb'
      - 'db/structure.sql'

  Reek:
    enabled: false
    description: 'Analyzing with Reek'
    required_executable: 'reek'
    flags: ['--single-line', '--no-color']
    install_command: 'gem install reek'
    include:
      - '**/*.gemspec'
      - '**/*.rake'
      - '**/*.rb'
      - '**/Gemfile'
      - '**/Rakefile'

  Rubocop:
    description: 'Analyzing with Rubocop'
    required_executable: 'rubocop'
    flags: ['--format=emacs', '--force-exclusion']
    install_command: 'gem install rubocop'
    include:
      - '**/*.gemspec'
      - '**/*.rake'
      - '**/*.rb'
      - '**/Gemfile'
      - '**/Rakefile'

  Scalastyle:
    description: 'Analyzing with Scalastyle'
    required_executable: 'scalastyle'
    include: '**/*.scala'

  ScssLint:
    description: 'Analyzing with scss-lint'
    required_executable: 'scss-lint'
    install_command: 'gem install scss-lint'
    include: '**/*.scss'

  SemiStandard:
    enabled: false
    description: 'Analyzing with semistandard'
    required_executable: 'semistandard'
    flags: ['--verbose']
    install_command: 'npm install -g semistandard'
    include: '**/*.js'

  ShellCheck:
    description: 'Analyzing with ShellCheck'
    required_executable: 'shellcheck'
    flags: ['--format=gcc']
    include: '**/*.sh'

  Standard:
    enabled: false
    description: 'Analyzing with standard'
    required_executable: 'standard'
    flags: ['--verbose']
    install_command: 'npm install -g standard'
    include: '**/*.js'

  TrailingWhitespace:
    description: 'Checking for trailing whitespace'
    required_executable: 'grep'
    flags: ['-IHn', '\s$']
    exclude:
      - '**/db/structure.sql'

  TravisLint:
    description: 'Checking Travis CI configuration'
    required_executable: 'travis'
    flags: ['lint']
    install_command: 'gem install travis'
    include: '.travis.yml'

  W3cCss:
    enabled: false
    description: 'Analyzing with W3C CSS validation service'
    validator_uri: 'http://jigsaw.w3.org/css-validator/validator'
    language: 'en'
    profile: 'css3'
    warn_level: 2
    include:
      - '**/*.css'

  W3cHtml:
    enabled: false
    description: 'Analyzing with W3C HTML validation service'
    validator_uri: 'http://validator.w3.org/check'
    charset: 'utf-8'
    doctype: 'HTML5'
    include:
      - '**/*.html'

  XmlLint:
    description: 'Analyzing with xmllint'
    required_executable: 'xmllint'
    flags: ['--noout']
    include: '**/*.xml'

  YamlSyntax:
    description: 'Checking YAML syntax'
    include:
      - '**/*.yaml'
      - '**/*.yml'

# Hooks that run after HEAD changes or a file is explicitly checked out.
PostCheckout:
  ALL:
    required: false
    quiet: false

  IndexTags:
    enabled: false
    description: 'Generating tags file from source'
    required_executable: 'ctags'

# Hooks that run after a commit is created.
PostCommit:
  ALL:
    requires_files: false
    required: false
    quiet: false

  GitGuilt:
    enabled: false
    description: 'Calculating changes in blame since last commit'
    requires_files: true
    required_executable: 'git-guilt'
    flags: ['HEAD~', 'HEAD']
    install_command: 'npm install -g git-guilt'

  IndexTags:
    enabled: false
    description: 'Generating tags file from source'
    required_executable: 'ctags'

# Hooks that run after `git merge` executes successfully (no merge conflicts).
PostMerge:
  ALL:
    requires_files: false
    quiet: false

  IndexTags:
    enabled: false
    description: 'Generating tags file from source'
    required_executable: 'ctags'

# Hooks that run after a commit is modified by an amend or rebase.
PostRewrite:
  ALL:
    requires_files: false
    quiet: false

  IndexTags:
    enabled: false
    description: 'Generating tags file from source'
    required_executable: 'ctags'