wip PintPreCommitHook

Author: igorsgm

src/Console/Commands/Hooks/PintPreCommitHook.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Igorsgm\GitHooks\Console\Commands\Hooks;
+
+use Closure;
+use Igorsgm\GitHooks\Contracts\PreCommitHook;
+use Igorsgm\GitHooks\Exceptions\HookFailException;
+use Igorsgm\GitHooks\Facades\GitHooks;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+use Igorsgm\GitHooks\Traits\ConsoleHelper;
+
+class PintPreCommitHook implements PreCommitHook
+{
+    use ConsoleHelper;
+
+    public function getName(): ?string
+    {
+        return 'Laravel Pint';
+    }
+
+    public function handle(ChangedFiles $files, Closure $next)
+    {
+        $stagedFilePaths = $files->getStaged()->map(function ($file) {
+            return $file->getFilePath();
+        })->toArray();
+
+        if (empty($stagedFilePaths) || GitHooks::isMergeInProgress()) {
+            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();
+        }
+
+        $errorFiles = [];
+        foreach ($stagedFilePaths as $stagedFilePath) {
+            $isPintProperlyFormatted = $this->runCommands('./vendor/bin/pint --test --config ./pint.json ' . $stagedFilePath,
+                [
+                    'cwd' => base_path(),
+                ])->isSuccessful();
+
+            if (!$isPintProperlyFormatted) {
+                if (empty($errorFiles)) {
+                    $this->newLine();
+                }
+
+                $this->output->writeln(
+                    sprintf("<fg=red> Pint Failed:</> %s", "$stagedFilePath")
+                );
+                $errorFiles[] = $stagedFilePath;
+            }
+        }
+
+        if (empty($errorFiles)) {
+            return $next($files);
+        }
+
+        $this->newLine();
+        $this->output->writeln(
+            sprintf("<bg=red;fg=white> COMMIT FAILED </> %s",
+                '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->runCommands(
+                [
+                    './vendor/bin/pint --config ./pint.json ' . $errorFilesString,
+                    'git add ' . $errorFilesString,
+                ],
+                ['cwd' => base_path()]
+            );
+        } else {
+            throw new HookFailException();
+        }
+    }
+
+    public function isPintInstalled()
+    {
+        return file_exists(base_path('vendor/bin/pint'));
+    }
+}

src/Contracts/Hook.php

@@ -9,5 +9,5 @@ interface Hook
      *
      * @return string
      */
-    public function getName(): string;
+    public function getName(): ?string;
 }

src/Traits/ConsoleHelper.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Igorsgm\GitHooks\Traits;
+
+use Illuminate\Console\Concerns\InteractsWithIO;
+use Illuminate\Console\Concerns\InteractsWithSignals;
+use Illuminate\Console\OutputStyle;
+use Symfony\Component\Console\Input\StringInput;
+use Symfony\Component\Console\Output\ConsoleOutput;
+
+trait ConsoleHelper
+{
+    use ProcessHelper,
+        InteractsWithIO,
+        InteractsWithSignals;
+
+    /**
+     * Holds an instance of the console output.
+     *
+     * @var \Symfony\Component\Console\Output\ConsoleOutput
+     */
+    protected $consoleOutput;
+
+    /**
+     * The output interface implementation.
+     *
+     * @var \Illuminate\Console\OutputStyle
+     */
+    protected $output;
+
+    /**
+     * Create a new console command instance.
+     *
+     * @return void
+     */
+    public function __construct($argInput = "")
+    {
+        $this->input = new StringInput($argInput);
+        $this->consoleOutput = new ConsoleOutput();
+        $this->output = new OutputStyle($this->input, $this->consoleOutput);
+    }
+}

src/Traits/GitHelper.php

@@ -60,4 +60,16 @@ public function updateCommitMessageContentInFile(string $path, string $message):
     {
         file_put_contents($path, $message);
     }
+
+    /**
+     * @read https://stackoverflow.com/questions/30733415/how-to-determine-if-git-merge-is-in-process#answer-30781568
+     * @return bool
+     */
+    public function isMergeInProgress()
+    {
+        $command = $this->runCommands('git merge HEAD &> /dev/null');
+
+        // If a merge is in progress, the process returns code 128
+        return $command->getExitCode() === 128;
+    }
 }

src/Traits/ProcessHelper.php

@@ -78,7 +78,7 @@ public function transformCommands($commands, $callback)
             }
 
             return $callback($value);
-        }, $commands);
+        }, (array) $commands);
     }
 
     /**

src/Traits/WithPipeline.php

@@ -97,6 +97,7 @@ protected function finishHookConsoleTask(): Closure
      */
     public function getHookTaskTitle(Hook $hook): string
     {
-        return sprintf('  <bg=blue;fg=white> HOOK </> %s', $hook->getName());
+        $hookName = $hook->getName() ?? class_basename($hook);
+        return sprintf('  <bg=blue;fg=white> HOOK </> %s', $hookName);
     }
 }