code-checker 0.2.2.post1

Run pre-commit code checkers

Contents

• About

• Currently supported checkers

  • Project checkers

  • File checkers

• Examples

• Installation

• Uninstallation

• Git hooks setup

• Checkers details

  • phpunit

  • pep257

  • pylint

  • pep8

  • unittest

  • jshint

  • intern

  • jscs

  • phpcs

  • rst-lint

About

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.

Currently supported checkers

Project checkers

• unittest:

  Python unittest

• phpunit:

  PHP unittest framework.

• intern:

  Test system for JavaScript.

File checkers

• 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.

Examples

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

Installation

pip install code-checker

Note

Installation of code-checker requires Python 3 and pip

Uninstallation

pip uninstall code-checker

Git hooks setup

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

Note

setup-githooks fail if .git/hooks/pre-commit already exists. You should delete it manually first. Also if precommit-checkers.yml already exists setup-githooks leaves it untouched.

Note

Make sure that every requirement of checkers (pylint, pep8, jshint etc.) are installed in your system, active virtual environment or project repository. You should install them manually.

Checkers details

phpunit

Result status

Status	Description
SUCCESS	If phpunit exit status is 0 (all tests passes)
WARNING	If phpunit exit status is 0 and skipped or incomplete test are found
ERROR	If phpunit exit status is not 0 (some tests fail)

Default config

Option	Default	Description
directory	null	If not null, pass <value> to phpunit command.
executable	phpunit	Set phpunit executable path.
bootstrap	null	If not null, pass –bootstrap <value> to phpunit command.

pep257

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
add-select	null	If not null, pass –add-select=<value> to pep257 command.
select	null	If not null, pass –select=<value> to pep257 command.
count	null	If not null, pass –count=<value> to pep257 command.
ignore	null	If not null, pass –ignore=<value> to pep257 command.
explain	null	If not null, pass –explain to pep257 command.
add-ignore	null	If not null, pass –add-ignore=<value> to pep257 command.
source	null	If not null, pass –source to pep257 command.

pylint

Result status

Status	Description
SUCCESS	If computed code rate is 10
WARNING	If computed code rate is greater or equal than accepted code rate
ERROR	If computed code rate is less than accepted code rate

Default config

Option	Default	Description
rcfile	null	If not null, pass –rcfile=<value> to pylint command.
accepted-code-rate	9

pep8

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
select	null	If not null, pass –select=<value> to pep8 command.
qq	null	If not null, pass -qq to pep8 command.
count	null	If not null, pass –count to pep8 command.
hang-closing	null	If not null, pass –hang-closing to pep8 command.
max-line-length	null	If not null, pass –max-line-length=<value> to pep8 command.
format	null	If not null, pass –format=<value> to pep8 command.
config	null	If not null, pass –config=<value> to pep8 command.
ignore	null	If not null, pass –ignore=<value> to pep8 command.
first	null	If not null, pass –first to pep8 command.
show-pep8	null	If not null, pass –show-pep8 to pep8 command.
quiet	null	If not null, pass –quiet to pep8 command.
statistics	null	If not null, pass –statistics to pep8 command.
show-source	null	If not null, pass –show-source to pep8 command.

unittest

Result status

Status	Description
SUCCESS	If unittest exit status is 0 (all tests passes)
WARNING	If unittest exit status is 0 and skipped test are found
ERROR	If unittest exit status is not 0 (some tests fail)

Default config

Option	Default	Description

jshint

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
config	null	If not null, pass –config <value> to jshint command.
executable	jshint	Set jshint executable path.

intern

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
config	null	If not null, pass config=<value> to intern command.
executable	intern-client	Set intern executable path.

jscs

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
config	null	If not null, pass –config <value> to jscs command.
es3	null	If not null, pass –es3 to jscs command.
preset	null	If not null, pass –preset <value> to jscs command.
executable	jscs	Set jscs executable path.
esnext	null	If not null, pass –esnext to jscs command.

phpcs

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
standard	null	If not null, pass –standard=<value> to phpcs command.
executable	phpcs	Set phpcs executable path.
encoding	utf-8	If not null, pass –encoding=<value> to phpcs command.

rst-lint

Result status

Status	Description
SUCCESS	If checker command exit status is 0
ERROR	If checker command exit status is not 0

Default config

Option	Default	Description
executable	rst-lint	Set rst-lint executable path.
encoding	utf-8	If not null, pass –encoding <value> to rst-lint command.