Register rules as PHPStan extension (#51)

* Register rules as PHPStan extension

* spaze/phpstan-disallowed-calls

* fix stuff

* fix CI

* require spaze/phpstan-disallowed-calls

* v5.14.0

* Deprecate NoAssignmentInIfRule

* fix rector

Author: spawnia

.github/workflows/validate.yml

@@ -82,7 +82,7 @@ jobs:
           php-version: "${{ matrix.php-version }}"
 
       - if: "! startsWith(matrix.php-version, 8)"
-        run: composer remove --dev --no-update rector/rector mll-lab/graphql-php-scalars
+        run: composer remove --dev --no-update rector/rector mll-lab/graphql-php-scalars spaze/phpstan-disallowed-calls
 
       - uses: ramsey/composer-install@v3
         with:

CHANGELOG.md

@@ -9,6 +9,16 @@ See [GitHub releases](https://github.com/mll-lab/php-utils/releases).
 
 ## Unreleased
 
+## v5.14.0
+
+### Added
+
+- Register rules as a PHPStan extension
+
+### Deprecated
+
+- Deprecate `NoAssignmentInIfRule`
+
 ## v5.13.0
 
 ### Added

README.md

@@ -47,9 +47,12 @@ or registered manually by adding the following to your `phpstan.neon`:
 
 ```diff
 includes:
-+- vendor/mll-lab/php-utils/phpstan-extension.neon
++- vendor/mll-lab/php-utils/extension.neon
++- vendor/mll-lab/php-utils/rules.neon
 ```
 
+Requires `spaze/phpstan-disallowed-calls`.
+
 ## Changelog
 
 See [`CHANGELOG.md`](CHANGELOG.md).

composer.json

@@ -37,10 +37,12 @@
     "phpstan/phpstan-strict-rules": "^1 || ^2.0.3",
     "phpunit/phpunit": "^9.6.22 || ^10.5.45 || ^11.5.10 || ^12.0.5",
     "rector/rector": "^1.2.10 || ^2.0.9",
+    "spaze/phpstan-disallowed-calls": "^4.4",
     "thecodingmachine/phpstan-safe-rule": "^1.2.0"
   },
   "suggest": {
-    "mll-lab/graphql-php-scalars": "To use the provided scalar types for GraphQL servers, requires version ^6.3"
+    "mll-lab/graphql-php-scalars": "To use the provided scalar types for GraphQL servers, requires version ^6.3",
+    "spaze/phpstan-disallowed-calls": "Required when using the PHPStan configuration from rules.neon directly or through the extension installer"
   },
   "autoload": {
     "psr-4": {
@@ -64,7 +66,8 @@
   "extra": {
     "phpstan": {
       "includes": [
-        "phpstan-extension.neon"
+        "extension.neon",
+        "rules.neon"
       ]
     }
   }

phpstan-extension.neon extension.neon

@@ -1,5 +1,6 @@
 includes:
-- phpstan-extension.neon
+- extension.neon
+- rules.neon
 parameters:
   level: max
   paths:

phpstan.neon

@@ -35,4 +35,8 @@
         // Rector uses PHPStan internally, which in turn requires Larastan to be set up correctly
         __DIR__ . '/vendor/larastan/larastan/bootstrap.php',
     ])
-    ->withPHPStanConfigs([__DIR__ . '/phpstan.neon']);
+    ->withPHPStanConfigs([
+        __DIR__ . '/phpstan.neon',
+        __DIR__ . '/vendor/larastan/larastan/extension.neon',
+        __DIR__ . '/vendor/spaze/phpstan-disallowed-calls/extension.neon',
+    ]);

rector.php

@@ -0,0 +1,12 @@
+rules:
+# TODO gradually enable those rules
+#- MLL\Utils\PHPStan\Rules\ThrowableClassNameRule
+#- MLL\Utils\PHPStan\Rules\VariableNameIdToIDRule
+parameters:
+  disallowedFunctionCalls:
+  - function: 'compact()'
+    message: 'makes refactoring code hard'
+    errorTip: 'use standard array syntax instead'
+  # https://github.com/itsgoingd/clockwork?tab=readme-ov-file#logging
+  - function: 'clock()'
+    message: 'remove debugging code'

rules.neon

@@ -44,7 +44,7 @@ public function removeSection(AbstractSection $section): void
     {
         foreach ($this->sections as $i => $s) {
             if ($s === $section) {
-                unset($this->sections[$i]);
+                unset($this->sections[$i]); // @phpstan-ignore unset.possiblyHookedProperty (we allow extension and can not disable all footguns)
             }
         }
     }

src/Microplate/SectionedMicroplate.php

@@ -14,6 +14,8 @@
  * Inspired by https://github.com/odan/phpstan-rules/blob/388db4cdf7c99e2978f20b1ed8801d748984812a/src/Rules/AssignmentInConditionRule.php.
  *
  * @implements Rule<If_>
+ *
+ * @deprecated we decided we do not want to enforce this rule
  */
 class NoAssignmentInIfRule implements Rule
 {

src/PHPStan/Rules/NoAssignmentInIfRule.php

@@ -13,7 +13,7 @@
 class VariableNameIdToIDRule implements Rule
 {
     /** Lists words or phrases that contain "Id" but are fine. */
-    protected const FALSE_POSITIVES = ['Identifier'];
+    protected const FALSE_POSITIVES = ['Identifier', 'Identity'];
 
     public function getNodeType(): string
     {