aydin-hassan/php-git-hooks

Some simple git hooks to run a variety of PHP analysis tools, including PHPUnit

Maintainers

Details

github.com/AydinHassan/PhpGitHooks

Source

Issues

Installs: 11

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 4

Forks: 1

Open Issues: 0

0.1.0-beta3 2014-01-23 16:10 UTC

GPL V2 395e35fa85c329912194be43ced515a000a1fd39

This package is auto-updated.

Last update: 2024-04-12 19:43:48 UTC

README

Latest Stable Version Latest Unstable Version

This project contains some simple scripts to run Unit tests and static analysis tools before allowing a commit.

Currently the tool will run:

  1. PHPUnit
  2. PHP Copy Paste Detector
  3. PHP Code Sniffer

The tool will only run phpcs on modified files where phpcpd will be run against all files. PHPUnit will be run if there if a phpunit.xml or phpunit.xml.dist file in the root of the project.

PHP Code Sniffer will be run with ps2 coding standard and warning will be ingored (eg line limits)

This script will look for binaries in either the project's vendor/bin directory first and will fall back to ~/.composer/vendor/bin so make sure the tools are installed with composer.

See PHP-FIG for the coding standards.

Install tools

composer global require 'phpunit/phpunit:3.7.*'
composer global require 'squizlabs/php_codesniffer:1.5.1'
composer global require 'sebastian/phpcpd=2.0.0'

Install hooks

composer global require 'aydin-hassan/php-git-hooks:0.1.0-beta3'
cd ~/.composer/vendor/aydin-hassan/php-git-hooks
./install.sh

If you have any existing repositories you should run git init in the root of the repo to enable the hooks in them. All new repos will inherit the hooks.

Done

Everytime you commit something from any newly cloned/ created repository these checks will be executed!

Todo

  • Figure out how to execute global hooks if local repo hooks are defined