jv-testes/pre-commit

Pre-commit hook

Pre commit hook

Checks in our pre-commit hook, _(*1)

• Syntax check with php lint (“php -l”): We check every committed file has a valid PHP syntax.
• Sync check of composer.json and composer.lock files: We check these two files are committed together in order to avoid committing the json but not the lock and generate some issue to another developers.
• PHP CS Fixer check: With the –dry-run parameter it does not fix, just say what the problems are. With the –fixers parameter you can control what fixers you want to execute.
• PHP Code Sniffer check: Same as before, but another rule that checks another rules.
• PHPMD: We have enabled the controversial rules.
• Unit Testing check: We run around 3.000 tests right now.

, _(*2)

, _(*3)

, _(*4)

INSTALLATION:, _(*5)

The recommended way to install this library is through Composer:, _(*6)

add jv-testes/pre-commit as a composer dependency., _(*7)

composer.json, _(*8)

"require-dev": {
    ...
    "jv-testes/pre-commit": ">=1.2.3"
}

USAGE:, _(*9)

When a developer clones the project, it just needs to:, _(*10)

Edit composer.json and add:, _(*11)

    "scripts": {
        "pre-update-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
        "pre-install-cmd": "PreCommit\\Composer\\Script\\Hooks::preHooks",
        "post-update-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks",
        "post-install-cmd": "PreCommit\\Composer\\Script\\Hooks::postHooks"
    }

Remembering to set up the hooks, _(*12)

Custom config

Copy arquives vendor/jv-testes/pre-commit/config/* to [project], _(*13)

Reference

Write your git hooks in PHP and keep them under git control, _(*14)

PHP_CodeSniffer, _(*15)

PHP-CS-FIX, _(*16)

PHPMD, _(*17)

Custom PHPCS and PHPMD, _(*18)