wip LarastanPreCommitHook.php

Author: igorsgm

composer.json

@@ -32,6 +32,7 @@
     "require-dev": {
         "laravel/pint": "^1.2",
         "mockery/mockery": "^1.5.1",
+        "nunomaduro/larastan": "^2.0",
         "orchestra/testbench": "^7.0",
         "pestphp/pest": "^1.22",
         "pestphp/pest-plugin-mock": "^1.0",

config/git-hooks.php

@@ -178,6 +178,11 @@
             'phpcbf_path' => env('PHPCBF_PATH', 'vendor/bin/phpcbf'),
             'standard' => env('PHPCS_STANDARD', 'phpcs.xml'),
         ],
+        'larastan' => [
+            'path' => env('LARASTAN_PATH', 'vendor/bin/phpstan'),
+            'config' => env('LARASTAN_CONFIG', 'phpstan.neon'),
+            'additional_params' => env('LARASTAN_ADDITIONAL_PARAMS', '--xdebug'),
+        ],
         'blade_formatter' => [
             'path' => env('BLADE_FORMATTER_PATH', 'node_modules/.bin/blade-formatter'),
             'config' => env('BLADE_FORMATTER_CONFIG', '.bladeformatterrc.json'),

src/Console/Commands/Hooks/BaseCodeAnalyzerPreCommitHook.php

@@ -24,6 +24,7 @@ abstract class BaseCodeAnalyzerPreCommitHook
 
     /**
      * Name of the hook
+     *
      * @var string
      */
     protected $name;
@@ -99,10 +100,7 @@ protected function analizeCommittedFiles($commitFiles)
     {
         /** @var ChangedFile $file */
         foreach ($commitFiles as $file) {
-            if (
-                (is_array($this->fileExtensions) && ! in_array($file->extension(), $this->fileExtensions)) ||
-                (is_string($this->fileExtensions) && ! preg_match($this->fileExtensions, $file->getFilePath()))
-            ) {
+            if (! $this->canFileBeAnalyzed($file)) {
                 continue;
             }
 
@@ -126,6 +124,19 @@ protected function analizeCommittedFiles($commitFiles)
         return $this;
     }
 
+    /**
+     * Checks whether the given ChangedFile can be analyzed based on its file extension and the list of allowed extensions.
+     */
+    protected function canFileBeAnalyzed(ChangedFile $file): bool
+    {
+        if (empty($this->fileExtensions) || $this->fileExtensions === 'all') {
+            return true;
+        }
+
+        return (is_array($this->fileExtensions) && in_array($file->extension(), $this->fileExtensions)) ||
+            (is_string($this->fileExtensions) && preg_match($this->fileExtensions, $file->getFilePath()));
+    }
+
     /**
      * Returns the message to display when the commit fails.
      *
@@ -175,7 +186,7 @@ protected function checkAnalyzerInstallation()
      */
     protected function suggestAutoFixOrExit()
     {
-        if (Terminal::hasSttyAvailable() &&
+        if (Terminal::hasSttyAvailable() && ! empty($this->fixerExecutable) &&
             $this->command->confirm('Would you like to attempt to correct files automagically?')
         ) {
             $errorFilesString = implode(' ', $this->filesBadlyFormattedPaths);

src/Console/Commands/Hooks/LarastanPreCommitHook.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Igorsgm\GitHooks\Console\Commands\Hooks;
+
+use Closure;
+use Igorsgm\GitHooks\Contracts\CodeAnalyzerPreCommitHook;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+
+class LarastanPreCommitHook extends BaseCodeAnalyzerPreCommitHook implements CodeAnalyzerPreCommitHook
+{
+    /**
+     * @var string
+     */
+    protected $configParam;
+
+    /**
+     * Name of the hook
+     *
+     * @var string
+     */
+    protected $name = 'Larastan';
+
+    /**
+     * Analyzes committed files using Larastan
+     *
+     * @param  ChangedFiles  $files  The list of committed files to analyze.
+     * @param  Closure  $next  The next hook in the chain to execute.
+     * @return mixed|null
+     */
+    public function handle(ChangedFiles $files, Closure $next)
+    {
+        $this->configParam = $this->configParam();
+
+        return $this->setAnalyzerExecutable(config('git-hooks.code_analyzers.larastan.path'))
+            ->handleCommittedFiles($files, $next);
+    }
+
+    /**
+     * Returns the command to run Larastan analyzer with the given configuration file.
+     * By default, it turns off XDebug if it’s enabled to achieve better performance.
+     */
+    public function analyzerCommand(): string
+    {
+        $additionalParams = config('git-hooks.code_analyzers.larastan.additional_params');
+
+        if (! empty($additionalParams)) {
+            // Removing configuration/c/xdebug parameters from additional parameters to avoid conflicts
+            // because they are already set in the command by default.
+            $additionalParams = preg_replace('/\s*--(configuration|c|xdebug)\b(=\S*)?\s*/', '', $additionalParams);
+        }
+
+        return trim(
+            sprintf('%s analyse %s --xdebug %s', $this->getAnalyzerExecutable(), $this->configParam, $additionalParams)
+        );
+    }
+
+    /**
+     * Empty fixer command because Larastan doesn't provide any type of auto-fixing.
+     */
+    public function fixerCommand(): string
+    {
+        return '';
+    }
+
+    /**
+     * Gets the command-line parameter for specifying the configuration file for Larastan.
+     *
+     * @return string The command-line parameter for the configuration file, or an empty string if not set.
+     */
+    protected function configParam(): string
+    {
+        $phpStanConfigFile = rtrim(config('git-hooks.code_analyzers.larastan.config'), '/');
+
+        return empty($phpStanConfigFile) ? '' : '--configuration='.$phpStanConfigFile;
+    }
+}