Use php and phpcs through docker.

Author: agtong

README.md

@@ -3,15 +3,19 @@
 ## About
 
 Auto installed git pre-commit hook for running [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
-code checking to PSR2 coding standard compliance. It checks only files that are to be committed.
+code checking to PSR12 coding standard compliance. It checks only files that are to be committed.
 
 Inspired by [Enforce code standards with composer, git hooks, and phpcs](http://tech.zumba.com/2014/04/14/control-code-quality/)
 
+## Requirement
+
+You need to have a docker service named `php` that is running `php-fpm`, eg. `yiisoftware/yii2-php:7.4-fpm`.
+
 ## Installation
 
 Install `agtong/phpcs-git-pre-commit` with composer require command:
 
-    composer require "agtong/phpcs-git-pre-commit"
+    composer require --dev "agtong/phpcs-git-pre-commit"
 
 Or alternatively, include a dependency for `agtong/phpcs-git-pre-commit` in your composer.json file manually:
 
@@ -36,7 +40,7 @@ Then run `composer install` or `composer update`. `pre-commit` hook will be inst
 
 Run `git commit` and pre-commit hook will check your committed files like if you run
 
-    ./vendor/bin/phpcs --standard=PSR2 --encoding=utf-8 --ignore=*/tests/* -n -p /path/to/file.php
+    docker-compose exec php /app/vendor/bin/phpcs --standard=PSR12 /path/to/file.php
 
 Note: the `tests` directory is excluded form this check.
 

composer.json

@@ -10,6 +10,6 @@
         }
     ],
     "require": {
-        "squizlabs/php_codesniffer": "3.*"
+        "squizlabs/php_codesniffer": "^2.7 || ^3.0"
     }
 }

src/pre-commit

@@ -1,7 +1,8 @@
 #!/bin/sh
 
-PROJECT=`php -r "echo dirname(dirname(dirname(realpath('$0'))));"`
-STAGED_FILES_CMD=`git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\\\.php`
+PROJECT=$(docker compose exec -T php php -r "echo dirname(dirname(dirname(realpath('$0'))));")
+STAGED_FILES_CMD=$(git diff --cached --name-only --diff-filter=ACMR HEAD | grep \\.php)
+UNSTAGED_FILES_CMD=$(git diff --name-only --diff-filter=ACMR | grep \\.php)
 
 # Determine if a file list is passed
 if [ "$#" -eq 1 ]
@@ -12,12 +13,24 @@ then
     SFILES="$1"
     IFS=$oIFS
 fi
+
 SFILES=${SFILES:-$STAGED_FILES_CMD}
 
+STAGED_BUT_MODIFIED_FILES=$(docker compose exec -T php php -r "\$sfiles=(explode(\"\\n\", '$SFILES'));\$usfiles=(explode(\"\\n\", '$UNSTAGED_FILES_CMD'));echo implode(\"\\n\",array_intersect(\$usfiles,\$sfiles));")
+
+if [ -z "$STAGED_BUT_MODIFIED_FILES" ]; then
+    echo "OK"
+else
+    echo "Files staged but then modified:\n"
+    echo "${STAGED_BUT_MODIFIED_FILES}"
+    exit 1
+fi
+
+
 echo "Checking PHP Lint..."
 for FILE in $SFILES
 do
-    php -l -d display_errors=0 $PROJECT/$FILE
+    docker compose exec -T php php -l -d display_errors=0 $PROJECT/$FILE
     if [ $? != 0 ]
     then
         echo "Fix the error before commit."
@@ -28,16 +41,14 @@ done
 
 if [ "$FILES" != "" ]
 then
-    echo "Running Code Sniffer. Code standard PSR2."
-    ./vendor/bin/phpcs --standard=PSR2 --encoding=utf-8 --ignore=*/tests/* -n -p $FILES
+    echo "Running Code Sniffer."
+    docker-compose exec -T php /app/vendor/bin/phpcs --standard=PSR12 $FILES
+
     if [ $? != 0 ]
     then
         echo "Fix the error before commit!"
-        echo "Run"
-        echo "  ./vendor/bin/phpcbf $FILES"
-        echo "for automatic fix or fix it manually."
         exit 1
     fi
 fi
 
-exit $?
+exit $?