wip: PintPreCommitHook command tweaks

Author: igorsgm

config/git-hooks.php

@@ -155,4 +155,23 @@
     'pre-push' => [
 
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Code Analyzers Configuration
+    |--------------------------------------------------------------------------
+    |
+    | The following variables are used to store the paths to bin executables for
+    | various code analyzer dependencies used in your Laravel application.
+    | This configuration node allows you to set up the paths for these executables.
+    | Here you can also specify the path to the configuration files they use to customize their behavior
+    |
+    */
+    'code_analyzers' => [
+        'laravel_pint' => [
+            'path' => env('LARAVEL_PINT_PATH', 'vendor/bin/pint'),
+            'config' => env('LARAVEL_PINT_CONFIG', 'pint.json'),
+        ],
+    ],
+
 ];

src/Console/Commands/Hooks/PintPreCommitHook.php

@@ -8,16 +8,46 @@
 use Igorsgm\GitHooks\Facades\GitHooks;
 use Igorsgm\GitHooks\Git\ChangedFiles;
 use Igorsgm\GitHooks\Traits\ConsoleHelper;
+use Symfony\Component\Console\Terminal;
 
 class PintPreCommitHook implements PreCommitHook
 {
     use ConsoleHelper;
 
+    /**
+     * @var string
+     */
+    private $pintExecutable;
+
+    /**
+     * @var string
+     */
+    private $pintConfig;
+
+    /**
+     * @var array
+     */
+    private $filesBadlyFormatted;
+
     public function getName(): ?string
     {
         return 'Laravel Pint';
     }
 
+    /**
+     * Create a new console command instance.
+     *
+     * @return void
+     */
+    public function __construct($argInput = '')
+    {
+        $this->initConsole($argInput);
+
+        $this->pintExecutable = './'.trim(config('git-hooks.code_analyzers.laravel_pint.path'), '/');
+        $this->pintConfig = './'.trim(config('git-hooks.code_analyzers.laravel_pint.config'), '/');
+        $this->filesBadlyFormatted = [];
+    }
+
     public function handle(ChangedFiles $files, Closure $next)
     {
         $stagedFilePaths = $files->getStaged()->map(function ($file) {
@@ -28,36 +58,28 @@ public function handle(ChangedFiles $files, Closure $next)
             return $next($files);
         }
 
-        if (! $this->isPintInstalled()) {
-            $this->newLine(2);
-            $this->output->writeln(
-                sprintf('<bg=red;fg=white> ERROR </> %s',
-                    'Pint is not installed. Please run <info>composer require laravel/pint --dev</info> to install it.')
-            );
-            $this->newLine();
-            throw new HookFailException();
-        }
+        $this->validatePintInstallation();
 
-        $errorFiles = [];
         foreach ($stagedFilePaths as $stagedFilePath) {
-            $isPintProperlyFormatted = $this->runCommands('./vendor/bin/pint --test --config ./pint.json '.$stagedFilePath,
+            $isPintProperlyFormatted = $this->runCommands(
+                sprintf('%s --test --config %s %s', $this->pintExecutable, $this->pintConfig, $stagedFilePath),
                 [
                     'cwd' => base_path(),
                 ])->isSuccessful();
 
             if (! $isPintProperlyFormatted) {
-                if (empty($errorFiles)) {
+                if (empty($this->filesBadlyFormatted)) {
                     $this->newLine();
                 }
 
                 $this->output->writeln(
                     sprintf('<fg=red> Pint Failed:</> %s', "$stagedFilePath")
                 );
-                $errorFiles[] = $stagedFilePath;
+                $this->filesBadlyFormatted[] = $stagedFilePath;
             }
         }
 
-        if (empty($errorFiles)) {
+        if (empty($this->filesBadlyFormatted)) {
             return $next($files);
         }
 
@@ -67,11 +89,45 @@ public function handle(ChangedFiles $files, Closure $next)
                 'Your commit contains files that should pass Pint but do not. Please fix the Pint errors in the files above and try again.')
         );
 
-        if ($this->confirm('Would you like to attempt to correct files automagically?', false)) {
-            $errorFilesString = implode(' ', $errorFiles);
+        $this->suggestAutoFixOrExit();
+    }
+
+    /**
+     * @return void
+     *
+     * @throws HookFailException
+     */
+    private function validatePintInstallation()
+    {
+        $isPintInstalled = file_exists(base_path(config('git-hooks.code_analyzers.laravel_pint.path')));
+
+        if ($isPintInstalled) {
+            return;
+        }
+
+        $this->newLine(2);
+        $this->output->writeln(
+            sprintf('<bg=red;fg=white> ERROR </> %s',
+                'Pint is not installed. Please run <info>composer require laravel/pint --dev</info> to install it.')
+        );
+        $this->newLine();
+        throw new HookFailException();
+    }
+
+    /**
+     * @return void
+     *
+     * @throws HookFailException
+     */
+    private function suggestAutoFixOrExit()
+    {
+        if (Terminal::hasSttyAvailable() &&
+            $this->confirm('Would you like to attempt to correct files automagically?', false)
+        ) {
+            $errorFilesString = implode(' ', $this->filesBadlyFormatted);
             $this->runCommands(
                 [
-                    './vendor/bin/pint --config ./pint.json '.$errorFilesString,
+                    sprintf('%s --config %s %s', $this->pintExecutable, $this->pintConfig, $errorFilesString),
                     'git add '.$errorFilesString,
                 ],
                 ['cwd' => base_path()]
@@ -80,9 +136,4 @@ public function handle(ChangedFiles $files, Closure $next)
             throw new HookFailException();
         }
     }
-
-    public function isPintInstalled()
-    {
-        return file_exists(base_path('vendor/bin/pint'));
-    }
 }

src/Console/Commands/stubs/hook

@@ -1,3 +1,7 @@
 #!/bin/sh
 
+if sh -c ": >/dev/tty" >/dev/null 2>/dev/null; then
+    exec < /dev/tty
+fi
+
 php {path}/artisan {command} $@ >&2

src/Traits/ConsoleHelper.php

@@ -33,7 +33,7 @@ trait ConsoleHelper
      *
      * @return void
      */
-    public function __construct($argInput = '')
+    public function initConsole($argInput = '')
     {
         $this->input = new StringInput($argInput);
         $this->consoleOutput = new ConsoleOutput();