fix: Add classmap autoloading and create Rule interface for PHPStan

guanguans · guanguans · commit 3ad2c5556b95 · 2026-01-19T13:31:38.000+08:00
- Included "stub/" directory in autoload-dev classmap for better autoloading during development
- Added new Rule interface in stub/phpstan/phpstan/src/Rules/Rule.php to define custom PHPStan rules and improve static analysis capabilities
diff --git a/.gitattributes b/.gitattributes
@@ -37,7 +37,7 @@
 /baselines/    export-ignore
 #/docs/         export-ignore
 #/examples/     export-ignore
-/stubs/        export-ignore
+/stub/         export-ignore
 /tests/        export-ignore
 /vendor-bin/   export-ignore
 /vendor/       export-ignore
diff --git a/composer.json b/composer.json
@@ -103,7 +103,10 @@
     "autoload-dev": {
         "psr-4": {
             "Guanguans\\PHPStanRulesTests\\": "tests/"
-        }
+        },
+        "classmap": [
+            "stub/"
+        ]
     },
     "config": {
         "allow-plugins": {
@@ -400,7 +403,7 @@
         "rector:process-only-dry-run": "@rector:process-only --dry-run",
         "roave-backward-compatibility-check": [
             "@putenv:php",
-            "$PHP82 vendor/bin/roave-backward-compatibility-check --ansi -vv"
+            "$PHP82 vendor/bin/roave-backward-compatibility-check --install-development-dependencies --ansi -vv"
         ],
         "roave-backward-compatibility-check:format-github-actions": "@roave-backward-compatibility-check --format=github-actions",
         "rule-doc-generator": [
diff --git a/config/rules.neon b/config/rules.neon
@@ -25,12 +25,6 @@ parameters:
         forbiddenSideEffects:
             enabled: %guanguans.allRules%
 
-conditionalTags:
-    Guanguans\PHPStanRules\Rule\Class_\ExceptionMustImplementNativeThrowableRule:
-        phpstan.rules.rule: %guanguans.exceptionMustImplementNativeThrowable.enabled%
-#    Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule:
-#        phpstan.rules.rule: %guanguans.forbiddenSideEffects.enabled%
-
 services:
     -
         class: Guanguans\PHPStanRules\Rule\Class_\ExceptionMustImplementNativeThrowableRule
@@ -40,3 +34,9 @@ services:
 #        class: staabm\SideEffectsDetector\SideEffectsDetector
 #    -
 #        class: Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule
+
+conditionalTags:
+    Guanguans\PHPStanRules\Rule\Class_\ExceptionMustImplementNativeThrowableRule:
+        phpstan.rules.rule: %guanguans.exceptionMustImplementNativeThrowable.enabled%
+#    Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule:
+#        phpstan.rules.rule: %guanguans.forbiddenSideEffects.enabled%
diff --git a/config/rules.php b/config/rules.php
@@ -19,11 +19,6 @@
 }
 
 return [
-    'conditionalTags' => [
-        ForbiddenSideEffectsRule::class => [
-            'phpstan.rules.rule' => '%guanguans.forbiddenSideEffects.enabled%',
-        ],
-    ],
     'services' => [
         [
             'class' => SideEffectsDetector::class,
@@ -32,4 +27,9 @@
             'class' => ForbiddenSideEffectsRule::class,
         ],
     ],
+    'conditionalTags' => [
+        ForbiddenSideEffectsRule::class => [
+            'phpstan.rules.rule' => '%guanguans.forbiddenSideEffects.enabled%',
+        ],
+    ],
 ];
diff --git a/rector.php b/rector.php
@@ -203,6 +203,7 @@ classes(static fn (string $class, string $file): bool => str_starts_with($class,
             __DIR__.'/src/Rule/*Rule.php',
         ],
         SortAssociativeArrayByKeyRector::class => [
+            __DIR__.'/config/',
             __DIR__.'/src/',
             __DIR__.'/tests/',
         ],
diff --git a/stub/.gitkeep b/stub/.gitkeep
diff --git a/stub/phpstan/phpstan/src/Rules/Rule.php b/stub/phpstan/phpstan/src/Rules/Rule.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 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/phpstan-rules
+ */
+
+namespace PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+
+if (interface_exists('PHPStan\Rules\Rule')) {
+    return;
+}
+
+/**
+ * @see https://github.com/Roave/BackwardCompatibilityCheck
+ * @see https://github.com/symplify/phpstan-rules/blob/main/stubs/
+ * @see vendor/phpstan/phpstan/phpstan.phar/src/Rules/Rule.php
+ *
+ * This is the interface custom rules implement. To register it in the configuration file
+ * use the `phpstan.rules.rule` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\MyRule
+ *		tags:
+ *			- phpstan.rules.rule
+ * ```
+ *
+ * Learn more: https://phpstan.org/developing-extensions/rules
+ *
+ * @api
+ *
+ * @template TNodeType of Node
+ */
+interface Rule
+{
+    /**
+     * @return class-string<TNodeType>
+     */
+    public function getNodeType(): string;
+
+    /**
+     * @param TNodeType $node
+     * @param \PHPStan\Analyser\NodeCallbackInvoker&\PHPStan\Analyser\Scope $scope
+     *
+     * @return list<IdentifierRuleError>
+     */
+    public function processNode(Node $node, Scope $scope): array;
+}
