This package is abandoned and no longer maintained. No replacement package was suggested.

Git hooks for PHP projects.

v2.0.1 2015-09-01 21:32 UTC

This package is auto-updated.

Last update: 2022-02-01 12:50:53 UTC


Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads Latest Unstable Version License SensioLabsInsight

Git hooks for PHP projects

Library based in git hook scripts for PHP projects.

Original scripts


Step 1: Composer

You must add the following line to the composer.json file:

    "require-dev": {
        "bruli/php-git-hooks": "2.*@dev"

Or you can write in your console:

$ composer require bruli/php-git-hooks --dev

If you don't have composer, you need download the binary file and run it:

# or
curl -O

php composer.phar install

Step 2: Configuration

Composer configuration.

After download all repositories, composer ask you about configuration.


Composer configuration in Symfony2 projects.

In Symfony2 projects you need add this lines in your composer.json:

"scripts": {
    "post-install-cmd": [
      ...other lines...
    "post-update-cmd": [
      ...other lines...

Important: To use 2.X version you need symfony 2.7 version.

Bin directory configuration.

If your project haven't a "bin" directory, you can add this in your compose.json file.

 "config": {
        "bin-dir": "bin"

Note: Not necessary for Symfony projects.

Manual config file for git hooks.

You can configure php-git-hooks, creating a php-git-hooks.yml file with...

  enabled: true
        enabled:  true
        level:    psr0
    phpunit:       true
    phplint:       true
    phpcs:         true
    phpmd:         true
    enabled: true
    regular-expression: '#[0-9]{2,7}'

... or you can copy php-git-hooks.yml.sample from vendor/bruli/php-git-hooks.

Update from v1.3.*

Php-cs-fixer configuration in php-git-hooks.yml file, is not compatible with 2.0 version. You should remove php-cs-fixer entry and execute "composer install".

Most easy way to update is delete php-git-hooks.yml and execute "composer install". You will see all the configuration questions again.

Config file for phpunit.

If you want use phpunit tool, you must create a phpunit.xml.dist in your project root directory. Alternatively you can copy from vendor/bruli/php-git-hooks/phpunit.xml.dist in your project root directory.

Config file for phpmd.

The same case that phpunit. You must create a PmdRules.xml in your project root directory or copy from php-git-hook directory.

Step 3: Enabling hooks.

The most easy way to enable hook is copy hook file into your .git/hooks directory.

#For pre-commit hook:

You can enable this hooks with composer or manually executing

 $cp vendor/bruli/php-git-hooks/hooks/pre-commit .git/hooks

#For commit-msg hook:

 $cp vendor/bruli/php-git-hooks/hooks/commit-msg .git/hooks


####Valid pre-commit. pre-commit.png ####Fail pre-commit. pre-commit-failed.png



php-git-hooks is released under the MIT License. See the bundled LICENSE file for details.