Merge remote-tracking branch 'origin/develop'

Author: igorsgm

config/git-hooks.php

@@ -177,7 +177,7 @@
         'php_code_sniffer' => [
             'phpcs_path' => env('PHPCS_PATH', 'vendor/bin/phpcs'),
             'phpcbf_path' => env('PHPCBF_PATH', 'vendor/bin/phpcbf'),
-            'standard' => env('PHPCS_STANDARD', 'phpcs.xml'),
+            'config' => env('PHPCS_STANDARD_CONFIG', 'phpcs.xml'),
             'file_extensions' => env('PHPCS_FILE_EXTENSIONS', '/\.php$/'),
         ],
         'larastan' => [

src/Console/Commands/Hooks/BaseCodeAnalyzerPreCommitHook.php

@@ -79,7 +79,7 @@ public function handleCommittedFiles(ChangedFiles $files, Closure $next)
             return $next($files);
         }
 
-        $this->checkAnalyzerInstallation()
+        $this->validateAnalyzerInstallation()
             ->analizeCommittedFiles($commitFiles);
 
         if (empty($this->filesBadlyFormattedPaths)) {
@@ -148,8 +148,10 @@ protected function commitFailMessage()
         $this->command->newLine();
 
         $message = '<bg=red;fg=white> COMMIT FAILED </> ';
-        $message .= sprintf("Your commit contains files that should pass %s but do not. Please fix the errors in the files above and try again.\n", $this->getName());
-        $message .= sprintf('You can check which %s errors happened in them by executing: <comment>%s {filePath}</comment>', $this->getName(), $this->analyzerCommand());
+        $message .= sprintf("Your commit contains files that should pass %s but do not. Please fix the errors in the files above and try again.\n",
+            $this->getName());
+        $message .= sprintf('You can check which %s errors happened in them by executing: <comment>%s {filePath}</comment>',
+            $this->getName(), $this->analyzerCommand());
 
         $this->command->getOutput()->writeln($message);
 
@@ -163,7 +165,7 @@ protected function commitFailMessage()
      *
      * @throws HookFailException
      */
-    protected function checkAnalyzerInstallation()
+    protected function validateAnalyzerInstallation()
     {
         if (file_exists($this->analyzerExecutable)) {
             return $this;
@@ -179,6 +181,22 @@ protected function checkAnalyzerInstallation()
         throw new HookFailException();
     }
 
+    protected function validateConfigPath($path)
+    {
+        if (file_exists($path)) {
+            return $this;
+        }
+
+        $this->command->newLine(2);
+        $this->command->getOutput()->writeln(
+            sprintf('<bg=red;fg=white> ERROR </> %s config file does not exist. Please check the path and try again.',
+                $this->getName())
+        );
+        $this->command->newLine();
+
+        throw new HookFailException();
+    }
+
     /**
      * Suggests attempting to automatically fix the incorrectly formatted files or exit.
      *

src/Console/Commands/Hooks/BladeFormatterPreCommitHook.php

@@ -62,6 +62,7 @@ public function fixerCommand(): string
     public function configParam(): string
     {
         $bladeFormatterConfig = rtrim(config('git-hooks.code_analyzers.blade_formatter.config'), '/');
+        $this->validateConfigPath($bladeFormatterConfig);
 
         return empty($bladeFormatterConfig) ? '' : '--config='.$bladeFormatterConfig;
     }

src/Console/Commands/Hooks/ESLintPreCommitHook.php

@@ -66,6 +66,7 @@ public function fixerCommand(): string
     protected function configParam(): string
     {
         $eslintConfig = rtrim(config('git-hooks.code_analyzers.eslint.config'), '/');
+        $this->validateConfigPath($eslintConfig);
 
         return empty($eslintConfig) ? '' : '--config='.$eslintConfig;
     }

src/Console/Commands/Hooks/LarastanPreCommitHook.php

@@ -70,6 +70,7 @@ public function fixerCommand(): string
     protected function configParam(): string
     {
         $phpStanConfigFile = rtrim(config('git-hooks.code_analyzers.larastan.config'), '/');
+        $this->validateConfigPath($phpStanConfigFile);
 
         return empty($phpStanConfigFile) ? '' : '--configuration='.$phpStanConfigFile;
     }

src/Console/Commands/Hooks/PHPCodeSnifferPreCommitHook.php

@@ -62,7 +62,8 @@ public function fixerCommand(): string
      */
     public function configParam(): string
     {
-        $phpCSStandard = rtrim(config('git-hooks.code_analyzers.php_code_sniffer.standard'), '/');
+        $phpCSStandard = rtrim(config('git-hooks.code_analyzers.php_code_sniffer.config'), '/');
+        $this->validateConfigPath($phpCSStandard);
 
         return empty($phpCSStandard) ? '' : '--standard='.$phpCSStandard;
     }

src/Console/Commands/Hooks/PintPreCommitHook.php

@@ -62,6 +62,8 @@ protected function configParam(): string
         $pintConfigFile = config('git-hooks.code_analyzers.laravel_pint.config');
 
         if (! empty($pintConfigFile)) {
+            $this->validateConfigPath($pintConfigFile);
+
             return '--config '.trim($pintConfigFile, '/');
         }
 

src/Console/Commands/Hooks/PrettierPreCommitHook.php

@@ -64,6 +64,7 @@ public function fixerCommand(): string
     protected function configParam(): string
     {
         $prettierConfig = rtrim(config('git-hooks.code_analyzers.prettier.config'), '/');
+        $this->validateConfigPath($prettierConfig);
 
         return empty($prettierConfig) ? '' : '--config='.$prettierConfig;
     }

tests/Datasets/PreCommitHooksDataset.php

@@ -28,7 +28,7 @@
         [
             'phpcs_path' => '../../../bin/phpcs',
             'phpcbf_path' => '../../../bin/phpcbf',
-            'standard' => __DIR__.'/../Fixtures/phpcsFixture.xml',
+            'config' => __DIR__.'/../Fixtures/phpcsFixture.xml',
             'file_extensions' => '/\.php$/',
         ],
     ],
@@ -79,6 +79,7 @@
 $nonExistentPath = [
     'path' => 'nonexistent/path',
     'phpcs_path' => 'nonexistent/path',
+    'config' => __DIR__.'/../Fixtures/pintFixture.json',
 ];
 
 dataset('codeAnalyzersList', [

tests/Features/Commands/Hooks/BaseCodeAnalyzerPreCommitHookTest.php

@@ -55,3 +55,21 @@ function ($configName, $nonExistentPathConfig, $preCommitHookClass, $listOfFixab
             ->expectsOutputToContain($preCommitHook->getName().' is not installed.')
             ->assertExitCode(1);
     })->with('codeAnalyzersList', 'listOfFixablePhpFiles');
+
+test('Throws HookFailException and notifies when config path does not exist',
+    function ($configName, $nonExistentPathConfig, $preCommitHookClass, $listOfFixablePhpFiles) {
+        $nonExistentPathConfig['config'] = 'nonexistent/path';
+        $this->config->set('git-hooks.code_analyzers.'.$configName, $nonExistentPathConfig);
+
+        $this->config->set('git-hooks.pre-commit', [
+            $preCommitHookClass,
+        ]);
+
+        GitHooks::shouldReceive('isMergeInProgress')->andReturn(false);
+        GitHooks::shouldReceive('getListOfChangedFiles')->andReturn($listOfFixablePhpFiles);
+
+        $preCommitHook = new $preCommitHookClass();
+        $this->artisan('git-hooks:pre-commit')
+            ->expectsOutputToContain($preCommitHook->getName().' config file does not exist.')
+            ->assertExitCode(1);
+    })->with('codeAnalyzersList', 'listOfFixablePhpFiles');