Updated phpstan standard, added rector and php insights support

Author: cradu

.github/workflows/main.yml

@@ -112,7 +112,10 @@ jobs:
         run: vendor/bin/phpstan
 
       - name: Execute Rector
-        run: vendor/bin/rector
+        run: vendor/bin/rector --dry-run
+
+      - name: Execute PHP Insights
+        run: vendor/bin/phpinsights --no-interaction
 
   laravel10-tests:
     runs-on: ubuntu-latest
@@ -212,7 +215,10 @@ jobs:
         run: vendor/bin/phpstan
 
       - name: Execute Rector
-        run: vendor/bin/rector
+        run: vendor/bin/rector --dry-run
+
+      - name: Execute PHP Insights
+        run: vendor/bin/phpinsights --no-interaction
 
   laravel11-tests:
     runs-on: ubuntu-latest
@@ -312,5 +318,8 @@ jobs:
         run: vendor/bin/phpstan
 
       - name: Execute Rector
-        run: vendor/bin/rector
+        run: vendor/bin/rector --dry-run
+
+      - name: Execute PHP Insights
+        run: vendor/bin/phpinsights --no-interaction
 

README.md

@@ -24,7 +24,7 @@
 
 ## ✨ Features
 
-- **Pre-configured Hooks:** Laravel Git Hooks comes with pre-configured pre-commit hooks for popular tools, such as Laravel Pint, PHPCS, ESLint, Prettier, Larastan, Enlightn, and Blade Formatter, making it easy to enforce coding standards and style guidelines right away.
+- **Pre-configured Hooks:** Laravel Git Hooks comes with pre-configured pre-commit hooks for popular tools, such as Laravel Pint, PHPCS, ESLint, Prettier, Larastan, Enlightn, Rector, PHP Insights and Blade Formatter, making it easy to enforce coding standards and style guidelines right away.
 - **Manage Git Hooks:** Easily manage your Git hooks in your Laravel projects with a streamlined and organized approach.
 - **Edit Commit Messages:** Gain control over your commit messages by customizing them to meet your project requirements and maintain a clean Git history.
 - **Create Custom Hooks:** Add and integrate custom hooks tailored to your specific project needs, ensuring better code quality and adherence to guidelines.
@@ -62,6 +62,8 @@ To use the already created pre-commit hooks of this package, you can simply edit
     \Igorsgm\GitHooks\Console\Commands\Hooks\EnlightnPreCommitHook::class, // Enlightn
     \Igorsgm\GitHooks\Console\Commands\Hooks\ESLintPreCommitHook::class, // ESLint
     \Igorsgm\GitHooks\Console\Commands\Hooks\PrettierPreCommitHook::class, // Prettier
+    \Igorsgm\GitHooks\Console\Commands\Hooks\PhpInsightsPreCommitHook::class, // PhpInsights
+    \Igorsgm\GitHooks\Console\Commands\Hooks\RectorPreCommitHook::class, // Rector
 ],
 ```
 

composer.json

@@ -34,6 +34,7 @@
         "larastan/larastan": "^2.9",
         "laravel/pint": "^1.2",
         "mockery/mockery": "^1.5.1",
+        "nunomaduro/phpinsights": "^2.11",
         "orchestra/testbench": "^v8.0.0|^v9.0.0",
         "pestphp/pest": "^2.0",
         "pestphp/pest-plugin-laravel": "^2.3",
@@ -57,7 +58,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "pestphp/pest-plugin": true
+            "pestphp/pest-plugin": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true
         }
     },
     "extra": {

config/git-hooks.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
 
     /*
@@ -200,6 +202,22 @@
             'run_in_docker' => env('BLADE_FORMATTER_RUN_IN_DOCKER', false),
             'docker_container' => env('BLADE_FORMATTER_DOCKER_CONTAINER', ''),
         ],
+        'rector' => [
+            'path' => env('RECTOR_PATH', 'vendor/bin/rector'),
+            'config' => env('RECTOR_CONFIG', 'rector.php'),
+            'file_extensions' => env('RECTOR_FILE_EXTENSIONS', '/\.php$/'),
+            'additional_params' => env('RECTOR_ADDITIONAL_PARAMS', ''),
+            'run_in_docker' => env('RECTOR_RUN_IN_DOCKER', false),
+            'docker_container' => env('RECTOR_DOCKER_CONTAINER', ''),
+        ],
+        'phpinsights' => [
+            'path' => env('PHPINSIGHTS_PATH', 'vendor/bin/phpinsights'),
+            'config' => env('PHPINSIGHTS_CONFIG', 'phpinsights.php'),
+            'file_extensions' => env('PHPINSIGHTS_FILE_EXTENSIONS', '/\.php$/'),
+            'additional_params' => env('PHPINSIGHTS_ADDITIONAL_PARAMS', ''),
+            'run_in_docker' => env('PHPINSIGHTS_RUN_IN_DOCKER', false),
+            'docker_container' => env('PHPINSIGHTS_DOCKER_CONTAINER', ''),
+        ],
         'prettier' => [
             'path' => env('PRETTIER_PATH', 'node_modules/.bin/prettier'),
             'config' => env('PRETTIER_CONFIG', '.prettierrc.json'),

phpinsights.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'preset' => 'laravel',
+    'exclude' => [
+        'src/Console/Commands/',
+        'src/HooksPipeline.php',
+        'src/Git/Log.php',
+    ],
+    'add' => [
+        //  ExampleMetric::class => [
+        //      ExampleInsight::class,
+        //  ]
+    ],
+    'remove' => [
+        SlevomatCodingStandard\Sniffs\Classes\ForbiddenPublicPropertySniff::class,
+        SlevomatCodingStandard\Sniffs\ControlStructures\DisallowEmptySniff::class,
+        SlevomatCodingStandard\Sniffs\TypeHints\DisallowMixedTypeHintSniff::class,
+        SlevomatCodingStandard\Sniffs\Classes\SuperfluousExceptionNamingSniff::class,
+        SlevomatCodingStandard\Sniffs\Functions\FunctionLengthSniff::class,
+        SlevomatCodingStandard\Sniffs\Commenting\DocCommentSpacingSniff::class,
+        NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff::class,
+        NunoMaduro\PhpInsights\Domain\Insights\CyclomaticComplexityIsHigh::class,
+        NunoMaduro\PhpInsights\Domain\Insights\ForbiddenNormalClasses::class,
+        NunoMaduro\PhpInsights\Domain\Insights\ForbiddenTraits::class,
+        PHP_CodeSniffer\Standards\Generic\Sniffs\Commenting\TodoSniff::class,
+        PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff::class,
+        PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer::class,
+    ],
+    'config' => [
+        //  ExampleInsight::class => [
+        //      'key' => 'value',
+        //  ],
+    ],
+    'requirements' => [
+        'min-quality' => 100,
+        'min-complexity' => 0,
+        'min-architecture' => 100,
+        'min-style' => 100,
+    ],
+];

phpstan.neon

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

rector.php

@@ -8,7 +8,6 @@
 return RectorConfig::configure()
     ->withPaths([
         __DIR__.'/src',
-        __DIR__.'/tests',
     ])
     // uncomment to reach your current PHP version
     ->withPhpSets()

src/Console/Commands/CommitMessage.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igorsgm\GitHooks\Console\Commands;
 
 use Igorsgm\GitHooks\Contracts\HookCommand;
@@ -19,12 +21,11 @@ class CommitMessage extends Command implements HookCommand
 
     /**
      * The console command description.
+     *
+     * @var string
      */
     protected $description = 'Run hook commit-msg';
 
-    /**
-     * {@inheritDoc}
-     */
     public function getHook(): string
     {
         return 'commit-msg';