This app runs any number of checks such as unit tests or linters during pre-commit check. If at least one check will not pass, commit is aborted.

Checkers are treated as jobs divided among couple of workers. Number of workers is equal to number of your cpu logical cores, every worker is executed in separate process (on separate cpu core).

In precommit-checkers.yml you can configure which checkers checks which files and define checkers configuration.

There are two categories of checkers: project-checkers and file-checker.

Every project-checker is executed only once during pre-commit check. Example of project-checker is unittest - this checker is executed for whole project.

file-checker can be executed for files in git staging area (git index). See Examples below.

Result of each checker has status which value is one of: SUCCESS, WARNING or ERROR. On SUCCESS and WARNING commit proceeds, on ERROR is aborted.

If you want to run checkers without commiting changes use check-code command.

• unittest:

  Python unittest

• phpunit:

  PHP unittest framework.

• intern:

  Test system for JavaScript.

• pylint:

  Pylint checker. Fail if code rate is below accepted-code-rate

• pep8:

  Python PEP8 checker.

• pep257:

  Python PEP257 checker.

• phpcs:

  PHP Code Sniffer: PHP coding standard linter.

• jshint:

  JSHint: JavaScript linter.

• jscs:

  JSCS - JavaScript code style linter

• rst-lint:

  A reStructuredText linter.

Below are example precommit-checkers.yml contents.

project-checkers: unittest
file-checkers:
  '*.py': [pylint, pep8]
  '*.js': jshint

If your precommit-checkers.yml is same as above, pre-commit check will execute python unittest for project, pylint and pep8 for *.py files and jshint for js files. pep8 and jshint checkers does not pass if at least one warning will occur. pylint does not pass if computed code rate is below accepted_code_rate, default accepted_code_rate is 9.

project-checkers: unittest
file-checkers:
  '*.py': [pylint, pep8]
  '*.js': jshint
config: 
  pylint: {accepted-code-rate: 8}

This example shows how to set global configuration for specified checkers. Above configuration has similar effect as previous example but here accepted code rate computed by pylint is set to 8.

project-checkers: unittest
file-checkers:
  '*.py': [pylint, pep8]
  'tests/*.py':
    - pylint: {accepted-code-rate: 8}
config: 
  pylint: {accepted-code-rate: 9}

Checker options can be set also for specific file pattern. In this example python modules under tests/ directory will be checked by pylint with accepted code rate 8. Rest of python modules will be checkek by pep8 and pylint with accepted code rate 9.

project-checkers: unittest
file-checkers:
  '*.py': [pylint, pep8]
  'tests/*.py':
    - pylint: {rcfile: tests/pylintrc}

This shows how to set custom pylintrc for tests modules

How to set jshint rc file:

file-checkers:
  '*.js': jshint
config:
  jshint: {config: .jshintrc}

Every previous examples assumes that checkers are installed globally in your system or active virtual environment. Some checkers accepts executable config option. Use this option if you want to select specific executable.

project-checkers: [phpunit, intern]
config:
  phpunit: {
    executable: vendor/phpunit/phpunit/phpunit,
    bootstrap: tests/bootstrap.php,
    directory: tests/TestSuite
  },
  intern: {
    config: tests/config.js,
    executable: node_modules/.bin/intern-client
  }

See Checkers details

pip install code-checker

pip uninstall code-checker

1. Install code-checker Installation
2. Change current working directory to git repository cd /path/to/repository
3. Execute setup-githooks. This command creates pre-commit hook which run checkers defined in precommit-checkers.yml