snapp-food/git-phpcs

Diff Sniffer for Git

Maintainers

Details

github.com/snapp-food/git-phpcs

Source

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 5

0.1.2 2018-05-28 05:38 UTC

Requires

Requires (Dev)

MIT eb5ba90250ea73f7842d949315f6abd9c6415f1b

  • Sergei Morozov <morozov.woop@tut.by>

This package is not auto-updated.

Last update: 2024-06-18 16:05:18 UTC

README

Diff Sniffer for Git

PHP Version Latest Stable Version Scrutinizer Code Quality Code Coverage Build Status Appveyor Build Status

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.