snapp-food / git-phpcs
Diff Sniffer for Git
Requires
- php: ^7.1
- morozov/diff-sniffer-core: ^3.1.1
Requires (Dev)
- phpstan/phpstan: ^0.9
- phpunit/phpunit: ^6.5
This package is not auto-updated.
Last update: 2025-03-25 19:45:50 UTC
README
This tool allows you using PHP_CodeSniffer as a pre-commit hook. The main difference from existing solutions that this one validates only changed lines of code but not the whole source tree.
Installation
Diff Sniffer is already built as a PHAR package. All you need is download it and install as a pre-commit hook.
$ wget https://github.com/diff-sniffer/git/releases/download/0.1.0/pre-commit.phar
$ chmod +x pre-commit.phar
$ mv pre-commit.phar /path/to/repo/.git/hooks/pre-commit
Alternatively, you can install the hook globally for a user (see man githooks):
$ git config --global core.hooksPath '~/.git/hooks' # choose a path if you already haven't
$ chmod +x pre-commit.phar
$ mv pre-commit.phar ~/.git/hooks/pre-commit
You can also install Diff Sniffer manually:
$ git clone git@github.com:diff-sniffer/git.git
$ cd diff-sniffer-pre-commit
$ composer install
$ bin/pre-commit --version
Continuous integration mode
Diff Sniffer for Git can also run on a CI server and validate pull requests. For example, on Travis CI:
$ wget https://github.com/diff-sniffer/git/releases/download/0.1.0/git-phpcs.phar
$ php git-phpcs.phar origin/$TRAVIS_BRANCH...$TRAVIS_PULL_REQUEST_SHA
Configuration
By default, the PHAR distribution uses the PSR2 coding standard. The configuration may be overridden by creating configuration file file in the project root.