feat(rules): Add configuration for ForbiddenSideEffectsRule

guanguans · guanguans · commit 08bf5a3e31e4 · 2026-01-19T12:43:54.000+08:00
- Introduced rules.php to define services for ForbiddenSideEffectsRule.
- Updated rules.neon to include conditional tags for the new rule.
- Excluded ForbiddenSideEffectsRule.php from PHPStan scanning.
diff --git a/config/rules.neon b/config/rules.neon
@@ -1,20 +1,8 @@
 # https://github.com/ergebnis/phpstan-rules/blob/main/rules.neon
 # https://github.com/symplify/phpstan-rules/tree/main/config/
 
-conditionalTags:
-    Guanguans\PHPStanRules\Rule\Class_\ExceptionMustImplementNativeThrowableRule:
-        phpstan.rules.rule: %guanguans.exceptionMustImplementNativeThrowable.enabled%
-    Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule:
-        phpstan.rules.rule: %guanguans.forbiddenSideEffects.enabled%
-
-parameters:
-    guanguans:
-        allRules: true
-        exceptionMustImplementNativeThrowable:
-            nativeThrowable: \Throwable
-            enabled: %guanguans.allRules%
-        forbiddenSideEffects:
-            enabled: false
+includes:
+    - rules.php
 
 parametersSchema:
     guanguans: structure([
@@ -28,13 +16,27 @@ parametersSchema:
         ])
     ])
 
-services:
-    -
-        class: staabm\SideEffectsDetector\SideEffectsDetector
+parameters:
+    guanguans:
+        allRules: true
+        exceptionMustImplementNativeThrowable:
+            nativeThrowable: \Throwable
+            enabled: %guanguans.allRules%
+        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
         arguments:
             nativeThrowable: %guanguans.exceptionMustImplementNativeThrowable.nativeThrowable%
-    -
-        class: Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule
+#    -
+#        class: staabm\SideEffectsDetector\SideEffectsDetector
+#    -
+#        class: Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule
diff --git a/config/rules.php b/config/rules.php
@@ -0,0 +1,35 @@
+<?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
+ */
+
+use Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule;
+use staabm\SideEffectsDetector\SideEffectsDetector;
+
+if (!class_exists(SideEffectsDetector::class)) {
+    return [];
+}
+
+return [
+    'conditionalTags' => [
+        ForbiddenSideEffectsRule::class => [
+            'phpstan.rules.rule' => '%guanguans.forbiddenSideEffects.enabled%',
+        ],
+    ],
+    'services' => [
+        [
+            'class' => SideEffectsDetector::class,
+        ],
+        [
+            'class' => ForbiddenSideEffectsRule::class,
+        ],
+    ],
+];
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -37,6 +37,7 @@ parameters:
     scanFiles:
         - vendor/composer/InstalledVersions.php
     excludePaths:
+#        - src/Rule/File/ForbiddenSideEffectsRule.php
         - src/Support/ComposerScripts.php
         - tests/Fixtures/
     tmpDir: .build/phpstan/
diff --git a/src/Rule/File/ForbiddenSideEffectsRule.php b/src/Rule/File/ForbiddenSideEffectsRule.php
@@ -31,9 +31,11 @@
  */
 final class ForbiddenSideEffectsRule extends AbstractRule
 {
+    /** @see \staabm\SideEffectsDetector\SideEffect */
     private const IGNORED_SIDE_EFFECTS = [
         'maybe_has_side_effects',
         'scope_pollution',
+        // 'unknown_class',
     ];
     private SideEffectsDetector $sideEffectsDetector;
 
