Added optional git pre-hook to validate with phpcs before every commit.

Author: mreduar

CHANGELOG.md

@@ -2,9 +2,13 @@
 
 All notable changes to `laravel-phpcs` will be documented in this file
 
+## 1.2.0 - 2022-01-27
+
+- Added optional git pre-hook to validate with phpcs before every commit.
+
 ## 1.1.0 - 2022-01-26
 
-- Excluded route files for Generic.CodeAnalysis.UnusedFunctionParameter rule
+- Excluded route files for Generic.CodeAnalysis.UnusedFunctionParameter rule.
 
 ## 1.0.0 - 2022-01-25
 

README.md

@@ -28,7 +28,7 @@ composer require mreduar/laravel-phpcs --dev
 
 > Only neccesary if you installed as a package using composer!
 
-`php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider"`
+`php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="ruleset"`
 
 This will publish to your root directory the following file
 
@@ -47,6 +47,23 @@ This will publish to your root directory the following file
 </ruleset>
 ```
 
+Optionally you can also publish a git hook that will help you to never overlook smelly code.
+
+`php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="hook"`
+
+The file will be published in its root directory `.git/hooks/pre-commit`
+So every time you try to commit `phpcs` will first check that you have everything correct.
+
+```bash
+$ git commit -m "test"
+[1/1] code sniffer        OK!
+[master a6133d7] test
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+```
+
+if you have any errors the commit will be cancelled.
+
+
 ### Sniffing code
 Use php CodeSniffer commands, pointed towards your xml file, to sniff the code
 using the new ruleset.

phpcs.xml.stub renamed to resources/stubs/phpcs.xml.stub

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# get bash colors and styles here:
+# http://misc.flogisoft.com/bash/tip_colors_and_formatting
+C_RESET='\e[0m'
+C_RED='\e[31m'
+C_GREEN='\e[32m'
+C_YELLOW='\e[33m'
+
+function __run() #(step, name, cmd)
+{
+    local color output exitcode
+
+    printf "${C_YELLOW}[%s]${C_RESET} %-20s" "$1" "$2"
+    output=$(eval "$3" 2>&1)
+    exitcode=$?
+
+    if [[ 0 == $exitcode || 130 == $exitcode ]]; then
+        echo -e "${C_GREEN}OK!${C_RESET}"
+    else
+        echo -e "${C_RED}NOK!${C_RESET}\n\n$output"
+        exit 1
+    fi
+}
+
+modified="git diff --diff-filter=M --name-only --cached  | grep \".php$\""
+ignore="resources/lang,resources/views,bootstrap/helpers,database/migrations,bin"
+phpcs="vendor/bin/phpcs --report=code --colors --report-width=80 --ignore=${ignore}"
+
+__run "1/1" "code sniffer" "${modified} | xargs -r ${phpcs}"
+# __run "2/3" "php lint" "${modified} | xargs -r php -l"
+# __run "3/3" "phpstan" "${modified} | xargs -r vendor/bin/phpstan analyse"

resources/stubs/pre-commit-hook.stub

@@ -13,8 +13,12 @@ public function boot()
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../phpcs.xml.stub' => base_path('phpcs.xml'),
+                __DIR__.'/../resources/stubs/phpcs.xml.stub' => base_path('phpcs.xml'),
             ], 'ruleset');
+
+            $this->publishes([
+                __DIR__.'/../resources/stubs/pre-commit-hook.stub' => base_path('.git/hooks/pre-commit'),
+            ], 'hook');
         }
     }
 }