feat(rector): Add driftingly-laravel configuration

guanguans · guanguans · commit b548d7e1df38 · 2026-02-01T23:22:43.000+08:00
- Introduce a new configuration file for driftingly-laravel
- Implement rules for renaming functions and classes in Laravel
- Ensure compatibility with the Laravel framework by checking class existence
diff --git a/composer.json b/composer.json
@@ -49,6 +49,7 @@
         "bamarni/composer-bin-plugin": "^1.9",
         "brainmaestro/composer-git-hooks": "^2.8 || ^3.0",
         "composer/composer": "^2.9",
+        "driftingly/rector-laravel": "^2.1",
         "ergebnis/composer-normalize": "^2.49",
         "ergebnis/license": "^2.7",
         "ergebnis/php-cs-fixer-config": "^6.59",
diff --git a/config/set/all.php b/config/set/all.php
@@ -20,6 +20,7 @@
     $rectorConfig->import(__DIR__.'/../config.php');
     $rectorConfig->sets([
         SetList::COMMON,
+        SetList::DRIFTINGLY_LARAVEL,
         SetList::GUZZLE,
         SetList::LARAVEL,
         SetList::PEST,
diff --git a/config/set/driftingly-laravel.php b/config/set/driftingly-laravel.php
@@ -0,0 +1,51 @@
+<?php
+
+/** @noinspection PhpInternalEntityUsedInspection */
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2025-2026 guanguans<ityaozm@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/guanguans/rector-rules
+ */
+
+use Illuminate\Foundation\Application;
+use Rector\Config\RectorConfig;
+use RectorLaravel\Set\LaravelSetList;
+use function Guanguans\RectorRules\Support\classes;
+
+return static function (RectorConfig $rectorConfig): void {
+    /**
+     * @required driftingly/rector-laravel
+     */
+    if (!class_exists(LaravelSetList::class) || !class_exists(Application::class)) {
+        return;
+    }
+
+    $rectorConfig->import(__DIR__.'/../config.php');
+
+    $rectorConfig->sets(
+        collect((new ReflectionClass(LaravelSetList::class))->getConstants())
+            ->reject(
+                static fn (string $_, string $name): bool => \in_array(
+                    $name,
+                    ['LARAVEL_STATIC_TO_INJECTION', 'LUMEN'],
+                    true
+                ) || preg_match('/^LARAVEL_\d{2,3}$/', $name)
+            )
+            // ->dd()
+            ->all()
+    );
+
+    $rectorConfig->rules(
+        classes(static fn (string $class): bool => str_starts_with($class, 'RectorLaravel\Rector'))
+            ->filter(static fn (ReflectionClass $reflectionClass): bool => $reflectionClass->isInstantiable())
+            ->keys()
+            // ->dd()
+            ->all()
+    );
+};
diff --git a/src/Set/SetList.php b/src/Set/SetList.php
@@ -20,6 +20,7 @@ final class SetList
 {
     public const ALL = __DIR__.'/../../config/set/all.php';
     public const COMMON = __DIR__.'/../../config/set/common.php';
+    public const DRIFTINGLY_LARAVEL = __DIR__.'/../../config/set/driftingly-laravel.php';
     public const GUZZLE = __DIR__.'/../../config/set/guzzle.php';
     public const LARAVEL = __DIR__.'/../../config/set/laravel.php';
     public const PEST = __DIR__.'/../../config/set/pest.php';
diff --git a/tests/Rector/AbstractRectorTestCase.php b/tests/Rector/AbstractRectorTestCase.php
@@ -90,7 +90,13 @@ final public function test(string $filePath): void
 
     final public static function provideCases(): iterable
     {
-        return self::yieldFilesFromDirectory(static::directory().'/Fixture/');
+        yield from self::yieldFilesFromDirectory(static::directory().'/Fixture/');
+
+        foreach ((array) glob(static::directory().'/Fixture[0-9]*/', \GLOB_ONLYDIR) as $directory) {
+            if ((int) (\PHP_MAJOR_VERSION.\PHP_MINOR_VERSION) >= (int) (string) Str::of($directory)->basename()->substr(7)) {
+                yield from self::yieldFilesFromDirectory($directory);
+            }
+        }
     }
 
     abstract protected static function directory(): string;
diff --git a/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture/skips.php.inc b/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture/skips.php.inc
@@ -13,14 +13,6 @@ interface Bar
     public function run($param): void;
 }
 
-class Baz
-{
-    // Skip promoted property parameter.
-    public function __construct(private Bar $bar)
-    {
-    }
-}
-
 use PhpParser\Node;
 use Rector\Rector\AbstractRector;
 
diff --git a/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture80/skips.php.inc b/tests/Rector/FunctionLike/RenameGarbageParamNameRector/Fixture80/skips.php.inc
@@ -0,0 +1,10 @@
+<?php
+
+/** @noinspection ALL */
+class Baz
+{
+    // Skip promoted property parameter.
+    public function __construct(private Bar $bar)
+    {
+    }
+}
diff --git a/tests/Rector/Name/RenameToConventionalCaseNameRector/Fixture81/fixture.php.inc b/tests/Rector/Name/RenameToConventionalCaseNameRector/Fixture81/fixture.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+/** @noinspection ALL */
+// @formatter:off
+// phpcs:ignoreFile
+
+enum Suit: string
+{
+    case Heart = 'Heart';
+    case Diamond = 'Diamond';
+    case Club = 'Club';
+    case Spade = 'Spade';
+}
+
+Suit::Heart;
+
+?>
+-----
+<?php
+
+/** @noinspection ALL */
+// @formatter:off
+// phpcs:ignoreFile
+
+enum Suit: string
+{
+    case Heart = 'Heart';
+    case Diamond = 'Diamond';
+    case Club = 'Club';
+    case Spade = 'Spade';
+}
+
+Suit::Heart;
+
+?>

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ final class SetList`
`20`	`20`	`{`
`21`	`21`	`public const ALL = __DIR__.'/../../config/set/all.php';`
`22`	`22`	`public const COMMON = __DIR__.'/../../config/set/common.php';`
	`23`	`+ public const DRIFTINGLY_LARAVEL = __DIR__.'/../../config/set/driftingly-laravel.php';`
`23`	`24`	`public const GUZZLE = __DIR__.'/../../config/set/guzzle.php';`
`24`	`25`	`public const LARAVEL = __DIR__.'/../../config/set/laravel.php';`
`25`	`26`	`public const PEST = __DIR__.'/../../config/set/pest.php';`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,13 @@ final public function test(string $filePath): void`
`90`	`90`
`91`	`91`	`final public static function provideCases(): iterable`
`92`	`92`	`{`
`93`		`- return self::yieldFilesFromDirectory(static::directory().'/Fixture/');`
	`93`	`+ yield from self::yieldFilesFromDirectory(static::directory().'/Fixture/');`
	`94`	`+`
	`95`	`+ foreach ((array) glob(static::directory().'/Fixture[0-9]*/', \GLOB_ONLYDIR) as $directory) {`
	`96`	`+ if ((int) (\PHP_MAJOR_VERSION.\PHP_MINOR_VERSION) >= (int) (string) Str::of($directory)->basename()->substr(7)) {`
	`97`	`+ yield from self::yieldFilesFromDirectory($directory);`
	`98`	`+ }`
	`99`	`+ }`
`94`	`100`	`}`
`95`	`101`
`96`	`102`	`abstract protected static function directory(): string;`