Add some git hooks

Author: exussum12

GitHooks/pre-commit

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+
+# This is a PSR-2 checking example for just the code about to be committed
+
+# Get the changes
+files=$(mktemp)
+diff=$(mktemp)
+
+git diff --cached --name-only --diff-filter=ACMR -- "*.php" > ${files}
+git diff --cached > ${diff}
+
+# Run the phpcs report
+phpcs=$(mktemp)
+./vendor/bin/phpcs --file-list=${files} --parallel=2 --standard=psr2 --report=json > ${phpcs} || true
+
+check for differences
+./vendor/bin/diffFilter --phpcs diff.txt phpcs.json

GitHooks/pre-receive

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# This is a PSR-2 checking example for just the code about to be committed
+
+# Get the changes
+files=$(mktemp)
+diff=$(mktemp)
+
+git diff --name-only --diff-filter=ACMR -- "*.php" $1...$2 > ${files}
+git diff $1...$2 > ${diff}
+
+# Run the phpcs report
+phpcs=$(mktemp)
+./vendor/bin/phpcs --file-list=${files} --parallel=2 --standard=psr2 --report=json > ${phpcs} || true
+
+check for differences
+./vendor/bin/diffFilter --phpcs diff.txt phpcs.json

README.md

@@ -9,6 +9,8 @@ Coverage checker allows new standards to be implemented incrementally, by only e
 
 Tools like phpcs and phpmd are an all or nothing approach, coverage checker allows this to work with the diff i.e. enforce all of the pull request / change request.
 
+This is sometimes called "Baselining"
+
 Also working with PHPunit to allow, for example 90% of new/edited code to be covered. which will increase the overall coverage over time.
 
 # Installing
@@ -54,6 +56,12 @@ diffFilter will exit with a `0` status if the changed code passes the minimum co
 ## Extended guide
 A more in depth guide can be [found on the wiki](https://github.com/exussum12/coverageChecker/wiki) also some tips for speeding up the build.
 
+## Installing as a git hook
+
+There are 2 examples hooks in the GitHooks directory, if you symlink to these diffFilter will run locally.
+
+pre-commit is before the commit happens
+pre-receive will prevent you pushing
 
 # Full list of available diff filters
 

examples/phpcsEnforce.sh

@@ -6,12 +6,11 @@ set -e
 
 # Get the diff (changes since the branch was created
 git diff origin/master... > diff.txt
-git diff origin/master... --name-only -- '*.php' > files.txt
+git diff origin/master... --name-only --diff-filter=ACMR -- '*.php' > files.txt
 
 
 # Old versions of phpcs will need to use the syntax commented out.
 # Note the || true is important, Without this phpcs failing will fail the build!
-# ./vendor/bin/phpcs --standard=psr2 src > phpcs.json || true
 
 ./vendor/bin/phpcs --file-list=files.txt --parallel=2 --standard=psr2 --report=json > phpcs.json || true