Merge pull request #23 from DaveLiddament/feature/add-rule-to-check-rules-in-extension-neon

Internal: Add rule to check rules in extension neon

Author: DaveLiddament

build/PHPStan/Rules/CheckRuleIsInExtension.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\PHPStan\Rules;
+
+use Nette\Neon\Neon;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/** @implements Rule<InClassNode> */
+final class CheckRuleIsInExtension implements Rule
+{
+    /** @var list<string> */
+    private array $classes;
+
+    public function __construct()
+    {
+        $file = Neon::decodeFile(__DIR__.'/../../../extension.neon');
+
+        if (!is_array($file)) {
+            throw new \Exception('Expecting neon file to be parseable');
+        }
+
+        $services = $file['services'] ?? [];
+
+        $classes = [];
+        foreach ($services as $service) {
+            $class = $service['class'] ?? null;
+            if (null === $class) {
+                continue;
+            }
+            $classes[] = $class;
+        }
+
+        $this->classes = $classes;
+    }
+
+    public function getNodeType(): string
+    {
+        return InClassNode::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        $classReflection = $scope->getClassReflection();
+        if (null === $classReflection) {
+            return [];
+        }
+
+        if (!$classReflection->isSubclassOf(Rule::class)) {
+            return [];
+        }
+
+        if ($classReflection->isAbstract()) {
+            return [];
+        }
+
+        $className = $classReflection->getName();
+
+        if (str_starts_with(haystack: $className, needle: 'DaveLiddament\PhpstanPhpLanguageExtensions\Build')) {
+            return [];
+        }
+
+        if (in_array($className, $this->classes)) {
+            return [];
+        }
+
+        return [
+            RuleErrorBuilder::message("Rule [$className] not in extension.neon.")->build(),
+        ];
+    }
+}

composer.json

@@ -12,7 +12,8 @@
     "phpunit/phpunit": "^9.6.12",
     "friendsofphp/php-cs-fixer": "^3.26.1",
     "php-parallel-lint/php-parallel-lint": "^1.3.2",
-    "dave-liddament/phpstan-rule-test-helper": "^0.3.0"
+    "dave-liddament/phpstan-rule-test-helper": "^0.3.0",
+    "nette/neon": "^3.4"
   },
   "license": "MIT",
   "autoload": {
@@ -22,7 +23,8 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "DaveLiddament\\PhpstanPhpLanguageExtensions\\Tests\\": "tests/"
+      "DaveLiddament\\PhpstanPhpLanguageExtensions\\Tests\\": "tests/",
+      "DaveLiddament\\PhpstanPhpLanguageExtensions\\Build\\": "build/"
     },
     "classmap": [
       "tests/Rules/data"

composer.lock

@@ -81,6 +81,17 @@ services:
         tags:
         - phpstan.rules.rule
 
+    -
+        class: DaveLiddament\PhpstanPhpLanguageExtensions\Rules\MustUseResultRule
+        tags:
+        - phpstan.rules.rule
+
+    -
+        class: DaveLiddament\PhpstanPhpLanguageExtensions\Rules\RestrictTraitToRule
+        tags:
+        - phpstan.rules.rule
+
+
 
 parametersSchema:
     phpLanguageExtensions: structure([

extension.neon

@@ -3,5 +3,13 @@ parameters:
     paths:
     - src
     - tests
+    - build
     excludePaths:
-    - tests/Rules/data
+    - tests/Rules/data
+
+services:
+
+-
+    class: DaveLiddament\PhpstanPhpLanguageExtensions\Build\PHPStan\Rules\CheckRuleIsInExtension
+    tags:
+    - phpstan.rules.rule