Merge pull request #41 from indy2kro/deprecate-laravel10-support

Deprecate Laravel 10 support

Author: indy2kro

.github/workflows/main.yml

@@ -19,20 +19,20 @@ permissions:
   contents: read
 
 jobs:
-  laravel10-tests:
+  laravel11-tests:
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
         operating-system: [ ubuntu-latest ]
-        php: [ '8.1', '8.2' ]
+        php: [ '8.2', '8.3', '8.4' ]
         dependency-stability: [ 'prefer-stable' ]
 
-        laravel: [ '10.*' ]
+        laravel: [ '11.*' ]
         include:
-          - laravel: 10.*
-            testbench: 8.*
+          - laravel: 11.*
+            testbench: 9.*
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - ${{ matrix.dependency-stability }} - ${{ matrix.operating-system}}
 
@@ -71,16 +71,16 @@ jobs:
         id: actions-cache
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-laravel-10-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
+          key: ${{ runner.os }}-composer-laravel-11-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: |
-            ${{ runner.os }}-composer-laravel-10-${{ matrix.php }}-
+            ${{ runner.os }}-composer-laravel-11-${{ matrix.php }}-
 
       - name: Cache PHP dependencies (vendor)
         uses: actions/cache@v4
         id: vendor-cache
         with:
           path: vendor
-          key: ${{ runner.os }}-build-laravel-10-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
+          key: ${{ runner.os }}-build-laravel-11-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
 
       - name: Install Laravel Dependencies
         if: steps.vendor-cache.outputs.cache-hit != 'true'
@@ -123,7 +123,7 @@ jobs:
       - name: Execute PHP Insights
         run: vendor/bin/phpinsights --disable-security-check --no-interaction
 
-  laravel11-tests:
+  laravel12-tests:
     runs-on: ubuntu-latest
 
     strategy:
@@ -133,9 +133,9 @@ jobs:
         php: [ '8.2', '8.3', '8.4' ]
         dependency-stability: [ 'prefer-stable' ]
 
-        laravel: [ '11.*' ]
+        laravel: [ '12.*' ]
         include:
-          - laravel: 11.*
+          - laravel: 12.*
             testbench: 9.*
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }} - ${{ matrix.dependency-stability }} - ${{ matrix.operating-system}}

.scrutinizer.yml

@@ -1,7 +1,7 @@
 build:
   environment:
     php:
-      version: 8.1
+      version: 8.2
     node: "v16.20.0"
   nodes:
     analysis:

README.md

@@ -60,6 +60,7 @@ To use the already created pre-commit hooks of this package, you can simply edit
 'pre-commit' => [
     \Igorsgm\GitHooks\Console\Commands\Hooks\PintPreCommitHook::class, // Laravel Pint
     \Igorsgm\GitHooks\Console\Commands\Hooks\PHPCodeSnifferPreCommitHook::class, // PHPCS (with PHPCBF autofixer) 
+    \Igorsgm\GitHooks\Console\Commands\Hooks\PHPCSFixerPreCommitHook::class, // PHP CS Fixer
     \Igorsgm\GitHooks\Console\Commands\Hooks\LarastanPreCommitHook::class, // Larastan
     \Igorsgm\GitHooks\Console\Commands\Hooks\EnlightnPreCommitHook::class, // Enlightn
     \Igorsgm\GitHooks\Console\Commands\Hooks\ESLintPreCommitHook::class, // ESLint
@@ -376,6 +377,10 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Credits
 
+- [Cristian Radu](https://github.com/indy2kro)
+
+Original authors:
+
 - [Igor Moraes](https://github.com/igorsgm)
 - [Pavel Buchnev](https://github.com/butschster)
 

composer.json

@@ -20,16 +20,17 @@
         }
     ],
     "require": {
-        "php": "^8.1",
-        "illuminate/config": "^10 || ^11 || ^12",
-        "illuminate/console": "^10 || ^11 || ^12",
-        "illuminate/container": "^10 || ^11 || ^12",
-        "illuminate/contracts": "^10 || ^11 || ^12",
-        "illuminate/pipeline": "^10 || ^11 || ^12",
-        "illuminate/support": "^10 || ^11 || ^12"
+        "php": "^8.2",
+        "illuminate/config": "^11 || ^12",
+        "illuminate/console": "^11 || ^12",
+        "illuminate/container": "^11 || ^12",
+        "illuminate/contracts": "^11 || ^12",
+        "illuminate/pipeline": "^11 || ^12",
+        "illuminate/support": "^11 || ^12"
     },
     "require-dev": {
         "enlightn/enlightn": "^2",
+        "friendsofphp/php-cs-fixer": "^3",
         "larastan/larastan": "^2 || ^3",
         "laravel/pint": "^1",
         "mockery/mockery": "^1",

config/git-hooks.php

@@ -184,16 +184,23 @@
             'phpcbf_path' => env('PHPCBF_PATH', 'vendor/bin/phpcbf'),
             'config' => env('PHPCS_STANDARD_CONFIG', 'phpcs.xml'),
             'file_extensions' => env('PHPCS_FILE_EXTENSIONS', '/\.php$/'),
-            'run_in_docker' => env('LARAVEL_PHPCS_RUN_IN_DOCKER', false),
-            'docker_container' => env('LARAVEL_PHPCS_DOCKER_CONTAINER', ''),
+            'run_in_docker' => env('PHPCS_RUN_IN_DOCKER', false),
+            'docker_container' => env('PHPCS_DOCKER_CONTAINER', ''),
+        ],
+        'php_cs_fixer' => [
+            'path' => env('PHPCSFIXER_PATH', 'vendor/bin/php-cs-fixer'),
+            'config' => env('PHPCSFIXER_STANDARD_CONFIG', '.php-cs-fixer.php'),
+            'file_extensions' => env('PHPCSFIXER_FILE_EXTENSIONS', '/\.php$/'),
+            'run_in_docker' => env('PHPCSFIXER_RUN_IN_DOCKER', false),
+            'docker_container' => env('PHPCSFIXER_DOCKER_CONTAINER', ''),
         ],
         'larastan' => [
             'path' => env('LARASTAN_PATH', 'vendor/bin/phpstan'),
             'config' => env('LARASTAN_CONFIG', 'phpstan.neon'),
             'additional_params' => env('LARASTAN_ADDITIONAL_PARAMS', '--xdebug'),
             'file_extensions' => env('LARASTAN_FILE_EXTENSIONS', '/\.php$/'),
-            'run_in_docker' => env('LARAVEL_LARASTAN_RUN_IN_DOCKER', false),
-            'docker_container' => env('LARAVEL_LARASTAN_DOCKER_CONTAINER', ''),
+            'run_in_docker' => env('LARASTAN_RUN_IN_DOCKER', false),
+            'docker_container' => env('LARASTAN_DOCKER_CONTAINER', ''),
         ],
         'blade_formatter' => [
             'path' => env('BLADE_FORMATTER_PATH', 'node_modules/.bin/blade-formatter'),

package-lock.json

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Igorsgm\GitHooks\Console\Commands\Hooks;
+
+use Closure;
+use Igorsgm\GitHooks\Contracts\CodeAnalyzerPreCommitHook;
+use Igorsgm\GitHooks\Git\ChangedFiles;
+
+class PHPCSFixerPreCommitHook extends BaseCodeAnalyzerPreCommitHook implements CodeAnalyzerPreCommitHook
+{
+    protected string $configParam;
+
+    /**
+     * Name of the hook
+     */
+    protected string $name = 'PHP_CS_Fixer';
+
+    /**
+     * Analyze and fix committed PHP files using PHP CS Fixer.
+     *
+     * @param  ChangedFiles  $files  The files that have been changed in the current commit.
+     * @param  Closure  $next  A closure that represents the next middleware in the pipeline.
+     */
+    public function handle(ChangedFiles $files, Closure $next): mixed
+    {
+        $this->configParam = $this->configParam();
+
+        return $this->setFileExtensions(config('git-hooks.code_analyzers.php_cs_fixer.file_extensions'))
+            ->setAnalyzerExecutable(config('git-hooks.code_analyzers.php_cs_fixer.path'))
+            ->setRunInDocker(config('git-hooks.code_analyzers.php_cs_fixer.run_in_docker'))
+            ->setDockerContainer(config('git-hooks.code_analyzers.php_cs_fixer.docker_container'))
+            ->handleCommittedFiles($files, $next);
+    }
+
+    /**
+     * Returns the command to run PHPCS
+     */
+    public function analyzerCommand(): string
+    {
+        return trim(sprintf('%s check %s', $this->getAnalyzerExecutable(), $this->configParam));
+    }
+
+    /**
+     * Returns the command to run PHPCS
+     */
+    public function fixerCommand(): string
+    {
+        return trim(sprintf('%s fix %s', $this->getAnalyzerExecutable(), $this->configParam));
+    }
+
+    /**
+     * Gets the command-line parameter for specifying the configuration file for PHP CS Fixer.
+     *
+     * @return string The configuration parameter for the analyzer.
+     */
+    public function configParam(): string
+    {
+        $configFile = (string) config('git-hooks.code_analyzers.php_cs_fixer.config');
+
+        if (! empty($configFile)) {
+            $this->validateConfigPath($configFile);
+
+            return '--config='.$configFile;
+        }
+
+        return '';
+    }
+}