Merge pull request #1 from indy2kro/v2-upgrade

Refactoring for strong typing enforce, added phpstan and rector

Author: indy2kro

.github/workflows/main.yml

@@ -108,6 +108,12 @@ jobs:
       - name: Execute Code Sniffer via Laravel Pint
         run: vendor/bin/pint --test src config
 
+      - name: Execute PHP Stan
+        run: vendor/bin/phpstan
+
+      - name: Execute Rector
+        run: vendor/bin/rector
+
   laravel10-tests:
     runs-on: ubuntu-latest
 
@@ -202,6 +208,12 @@ jobs:
       - name: Execute Code Sniffer via Laravel Pint
         run: vendor/bin/pint --test src config
 
+      - name: Execute PHP Stan
+        run: vendor/bin/phpstan
+
+      - name: Execute Rector
+        run: vendor/bin/rector
+
   laravel11-tests:
     runs-on: ubuntu-latest
 
@@ -296,3 +308,9 @@ jobs:
       - name: Execute Code Sniffer via Laravel Pint
         run: vendor/bin/pint --test src config
 
+      - name: Execute PHP Stan
+        run: vendor/bin/phpstan
+
+      - name: Execute Rector
+        run: vendor/bin/rector
+

composer.json

@@ -37,6 +37,7 @@
         "orchestra/testbench": "^v8.0.0|^v9.0.0",
         "pestphp/pest": "^2.0",
         "pestphp/pest-plugin-laravel": "^2.3",
+        "rector/rector": "^1.0",
         "squizlabs/php_codesniffer": "^3.7"
     },
     "autoload": {

config/git-hooks.php

@@ -245,7 +245,7 @@
     | during execution directly for easy debug.
     |
     */
-    'output_errors' => false,
+    'output_errors' => env('GITHOOKS_OUTPUT_ERRORS', false),
 
     /*
     |--------------------------------------------------------------------------
@@ -256,7 +256,7 @@
     | automatically run the fixer without any CLI prompt.
     |
     */
-    'automatically_fix_errors' => false,
+    'automatically_fix_errors' => env('GITHOOKS_AUTOMATICALLY_FIX_ERRORS', false),
 
     /*
     |--------------------------------------------------------------------------
@@ -268,7 +268,7 @@
     | The git hooks will not fail in case the re-run is succesful.
     |
     */
-    'rerun_analyzer_after_autofix' => false,
+    'rerun_analyzer_after_autofix' => env('GITHOOKS_RERUN_ANALYZER_AFTER_AUTOFIX', false),
 
     /*
     |--------------------------------------------------------------------------
@@ -279,7 +279,7 @@
     | stop (or not) at the first analyzer failure encountered.
     |
     */
-    'stop_at_first_analyzer_failure' => true,
+    'stop_at_first_analyzer_failure' => env('GITHOOKS_STOP_AT_FIRST_ANALYZER_FAILURE', true),
 
     /*
     |--------------------------------------------------------------------------
@@ -290,7 +290,7 @@
     | display the commands that are executed (usually for debug purpose).
     |
     */
-    'debug_commands' => false,
+    'debug_commands' => env('GITHOOKS_DEBUG_COMMANDS', false),
 
     /*
     |--------------------------------------------------------------------------
@@ -301,5 +301,5 @@
     | command during execution directly for easy debug.
     |
     */
-    'debug_output' => false,
+    'debug_output' => env('GITHOOKS_DEBUG_OUTPUT', false),
 ];

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    paths:
+        - ./src
+    # The level 9 is the highest level (with check for mixed type)
+    level: 6

rector.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddVoidReturnTypeWhereNoReturnRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+    // uncomment to reach your current PHP version
+    ->withPhpSets()
+    ->withRules([
+        AddVoidReturnTypeWhereNoReturnRector::class,
+    ]);

src/Console/Commands/Hooks/BaseCodeAnalyzerPreCommitHook.php

@@ -3,6 +3,7 @@
 namespace Igorsgm\GitHooks\Console\Commands\Hooks;
 
 use Closure;
+use Igorsgm\GitHooks\Contracts\CodeAnalyzerPreCommitHook;
 use Igorsgm\GitHooks\Exceptions\HookFailException;
 use Igorsgm\GitHooks\Facades\GitHooks;
 use Igorsgm\GitHooks\Git\ChangedFile;
@@ -14,66 +15,55 @@
 use Illuminate\Support\Collection;
 use Symfony\Component\Console\Terminal;
 
-abstract class BaseCodeAnalyzerPreCommitHook
+abstract class BaseCodeAnalyzerPreCommitHook implements CodeAnalyzerPreCommitHook
 {
     use ProcessHelper;
     use WithPipelineFailCheck;
 
     /**
      * Command instance that is bound automatically by Hooks Pipeline, so it can be used inside the Hook.
-     *
-     * @var Command
      */
-    public $command;
+    public Command $command;
 
     /**
      * Name of the hook
-     *
-     * @var string
      */
-    protected $name;
+    protected string $name;
 
-    /*
+    /**
      * List of files extensions that will be analyzed by the hook.
      * Can also be a regular expression.
-     * @var array|string
+     *
+     * @var array<int, string>|string
      */
-    public $fileExtensions = [];
+    public array|string $fileExtensions = [];
 
     /**
      * The path to the analyzer executable.
-     *
-     * @var string
      */
-    protected $analyzerExecutable;
+    protected string $analyzerExecutable;
 
     /**
      * The path to the fixer executable. In multiple cases it's the same of the analyzer executable.
-     *
-     * @var string
      */
-    protected $fixerExecutable;
+    protected string $fixerExecutable;
 
     /**
      * The list of paths of files that are badly formatted and should be fixed.
      *
-     * @var array
+     * @var array<int, string>
      */
-    protected $filesBadlyFormattedPaths = [];
+    protected array $filesBadlyFormattedPaths = [];
 
     /**
      * Run tool in docker
-     *
-     * @var bool
      */
-    protected $runInDocker = false;
+    protected bool $runInDocker = false;
 
     /**
      * Docker container on which to run
-     *
-     * @var string
      */
-    protected $dockerContainer = '';
+    protected string $dockerContainer = '';
 
     public function __construct()
     {
@@ -83,13 +73,9 @@ public function __construct()
     /**
      * Handles the committed files and checks if they are properly formatted.
      *
-     * @param  ChangedFiles  $files  The instance of the changed files.
-     * @param  Closure  $next  The closure to be executed after the files are handled.
-     * @return mixed|void
-     *
      * @throws HookFailException If the hook fails to analyze the committed files.
      */
-    public function handleCommittedFiles(ChangedFiles $files, Closure $next)
+    public function handleCommittedFiles(ChangedFiles $files, Closure $next): mixed
     {
         $commitFiles = $files->getStaged();
 
@@ -115,10 +101,10 @@ public function handleCommittedFiles(ChangedFiles $files, Closure $next)
      * whether it is properly formatted according to the configured analyzer, and collects
      * paths of any files that are not properly formatted.
      *
-     * @param  ChangedFile[]|Collection  $commitFiles  The files to analyze.
+     * @param  Collection<int, ChangedFile>  $commitFiles  The files to analyze.
      * @return $this
      */
-    protected function analizeCommittedFiles($commitFiles)
+    protected function analizeCommittedFiles(Collection $commitFiles): self
     {
         foreach ($commitFiles as $file) {
             if (! $this->canFileBeAnalyzed($file)) {
@@ -175,10 +161,8 @@ protected function canFileBeAnalyzed(ChangedFile $file): bool
 
     /**
      * Returns the message to display when the commit fails.
-     *
-     * @return $this
      */
-    protected function commitFailMessage()
+    protected function commitFailMessage(): self
     {
         $this->command->newLine();
 
@@ -196,11 +180,9 @@ protected function commitFailMessage()
     /**
      * Check if the BaseCodeAnalyzerPreCommitHook is installed.
      *
-     * @return $this
-     *
      * @throws HookFailException
      */
-    protected function validateAnalyzerInstallation()
+    protected function validateAnalyzerInstallation(): self
     {
         if (file_exists($this->analyzerExecutable)) {
             return $this;
@@ -219,12 +201,9 @@ protected function validateAnalyzerInstallation()
     /**
      * Validates the given configuration path.
      *
-     * @param  string  $path  The path to the configuration file.
-     * @return $this This instance for method chaining.
-     *
      * @throws HookFailException If the configuration file does not exist.
      */
-    protected function validateConfigPath($path)
+    protected function validateConfigPath(string $path): self
     {
         if (file_exists($path)) {
             return $this;
@@ -282,7 +261,6 @@ protected function suggestAutoFixOrExit(): bool
      * configured fixer command. For each fixed file, adds it to Git and removes its path
      * from the `$filesBadlyFormattedPaths` array.
      *
-     *
      * @throws HookFailException if any files cannot be fixed.
      */
     private function autoFixFiles(): bool
@@ -344,6 +322,11 @@ public function getOutput(): ?OutputStyle
         return $this->command->getOutput();
     }
 
+    public function setCommand(Command $command): void
+    {
+        $this->command = $command;
+    }
+
     /**
      * Get the name of the hook.
      */
@@ -353,20 +336,16 @@ public function getName(): ?string
     }
 
     /**
-     * @param  array|string  $fileExtensions
-     * @return BaseCodeAnalyzerPreCommitHook
+     * @param  array<int, string>|string  $fileExtensions
      */
-    public function setFileExtensions($fileExtensions)
+    public function setFileExtensions(array|string $fileExtensions): self
     {
         $this->fileExtensions = $fileExtensions;
 
         return $this;
     }
 
-    /**
-     * @return BaseCodeAnalyzerPreCommitHook
-     */
-    public function setAnalyzerExecutable($executablePath, $isSameAsFixer = false)
+    public function setAnalyzerExecutable(string $executablePath, bool $isSameAsFixer = false): self
     {
         $this->analyzerExecutable = './'.trim($executablePath, '/');
 
@@ -378,12 +357,9 @@ public function getAnalyzerExecutable(): string
         return $this->analyzerExecutable;
     }
 
-    /**
-     * @return BaseCodeAnalyzerPreCommitHook
-     */
-    public function setFixerExecutable($exacutablePath)
+    public function setFixerExecutable(string $executablePath): self
     {
-        $this->fixerExecutable = './'.trim($exacutablePath, '/');
+        $this->fixerExecutable = './'.trim($executablePath, '/');
 
         return $this;
     }
@@ -393,10 +369,7 @@ public function getFixerExecutable(): string
         return $this->fixerExecutable;
     }
 
-    /**
-     * @return BaseCodeAnalyzerPreCommitHook
-     */
-    public function setRunInDocker($runInDocker)
+    public function setRunInDocker(bool $runInDocker): self
     {
         $this->runInDocker = (bool) $runInDocker;
 
@@ -408,11 +381,7 @@ public function getRunInDocker(): bool
         return $this->runInDocker;
     }
 
-    /**
-     * @param  string  $dockerContainer
-     * @return BaseCodeAnalyzerPreCommitHook
-     */
-    public function setDockerContainer($dockerContainer)
+    public function setDockerContainer(string $dockerContainer): self
     {
         $this->dockerContainer = $dockerContainer;
 

src/Console/Commands/Hooks/BladeFormatterPreCommitHook.php

@@ -8,17 +8,9 @@
 
 class BladeFormatterPreCommitHook extends BaseCodeAnalyzerPreCommitHook implements CodeAnalyzerPreCommitHook
 {
-    /**
-     * @var string
-     */
-    protected $configParam;
+    protected string $configParam;
 
-    /**
-     * Name of the hook
-     *
-     * @var string
-     */
-    protected $name = 'Blade Formatter';
+    protected string $name = 'Blade Formatter';
 
     /**
      * Analyze and fix committed blade.php files using blade-formatter npm package
@@ -63,7 +55,7 @@ public function fixerCommand(): string
      */
     public function configParam(): string
     {
-        $bladeFormatterConfig = rtrim(config('git-hooks.code_analyzers.blade_formatter.config'), '/');
+        $bladeFormatterConfig = rtrim((string) config('git-hooks.code_analyzers.blade_formatter.config'), '/');
         $this->validateConfigPath($bladeFormatterConfig);
 
         return empty($bladeFormatterConfig) ? '' : '--config='.$bladeFormatterConfig;