Add support for LiveComponents in PHPStan rules and documentation

Author: Kocal

AGENTS.md

@@ -2,7 +2,10 @@
 
 ## Project Overview
 
-This project contains custom PHPStan rules to improve static analysis of Symfony UX applications, particularly for Twig components.
+This project contains custom PHPStan rules to improve static analysis of Symfony UX applications, particularly for Twig components and Live components.
+
+> [!NOTE]
+> All TwigComponent rules also apply to LiveComponents (classes annotated with `#[AsLiveComponent]`), since LiveComponents are enhanced TwigComponents.
 
 ## Project Structure
 
@@ -37,6 +40,7 @@ use PhpParser\Node\Stmt\Class_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -51,7 +55,7 @@ final class MyRuleRule implements Rule
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 
@@ -149,9 +153,9 @@ rules:
 ```
 
 #### Fixtures:
-- **InvalidCase.php**: Example that violates the rule
-- **ValidCase.php**: Example that complies with the rule
-- **NotAComponent.php**: Class without `#[AsTwigComponent]` (should not trigger an error)
+- **InvalidCase.php**: Example that violates the rule (both for TwigComponent and LiveComponent)
+- **ValidCase.php**: Example that complies with the rule (both for TwigComponent and LiveComponent)
+- **NotAComponent.php**: Class without `#[AsTwigComponent]` or `#[AsLiveComponent]` (should not trigger an error)
 
 ### 3. Document the rule in `README.md`
 

README.md

@@ -1,6 +1,6 @@
 # PHPStan for Symfony UX
 
-A set of PHPStan rules to improve static analysis for Symfony UX applications.
+A set of PHPStan rules to improve static analysis for [Symfony UX](https://github.com/symfony/ux) applications.
 
 ## Installation
 
@@ -10,8 +10,17 @@ To install the PHPStan rules for Symfony UX, you can use Composer:
 composer require --dev kocal/phpstan-symfony-ux
 ```
 
+## Configuration
+
+After installing the package, you need to configure PHPStan to use the rules.
+
+Each rule can be enabled individually by adding it to your `phpstan.dist.neon` configuration file.
+
 ## TwigComponent Rules
 
+> [!NOTE]
+> All these rules also apply to LiveComponents (classes annotated with `#[AsLiveComponent]`), since LiveComponents are enhanced TwigComponents.
+
 ### ClassNameShouldNotEndWithComponentRule
 
 Forbid Twig Component class names from ending with "Component" suffix, as it creates redundancy since the class is already identified as a component through the `#[AsTwigComponent]` attribute.

composer.json

@@ -36,6 +36,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^11.1",
+        "symfony/ux-live-component": "^2.0",
         "symfony/ux-twig-component": "^2.0",
         "symplify/easy-coding-standard": "^13.0"
     },

src/NodeAnalyzer/AttributeFinder.php

@@ -46,4 +46,26 @@ public static function findAttribute(ClassMethod | Property | ClassLike | Param
 
         return null;
     }
+
+    /**
+     * Find any of the provided attributes.
+     *
+     * @param string[] $desiredAttributeClasses
+     */
+    public static function findAnyAttribute(ClassMethod | Property | ClassLike | Param $node, array $desiredAttributeClasses): ?Attribute
+    {
+        $attributes = self::findAttributes($node);
+
+        foreach ($attributes as $attribute) {
+            if (! $attribute->name instanceof FullyQualified) {
+                continue;
+            }
+
+            if (in_array($attribute->name->toString(), $desiredAttributeClasses, true)) {
+                return $attribute;
+            }
+        }
+
+        return null;
+    }
 }

src/Rules/TwigComponent/ClassNameShouldNotEndWithComponentRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -24,7 +25,7 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 

src/Rules/TwigComponent/ExposePublicPropsShouldBeFalseRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -24,18 +25,24 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! $asTwigComponent = AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! $attribute = AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 
-        $exposePublicPropsValue = $this->getExposePublicPropsValue($asTwigComponent);
+        $exposePublicPropsValue = $this->getExposePublicPropsValue($attribute);
 
         if ($exposePublicPropsValue !== false) {
             return [
-                RuleErrorBuilder::message('The #[AsTwigComponent] attribute must have its "exposePublicProps" parameter set to false.')
+                RuleErrorBuilder::message(sprintf(
+                    'The #[%s] attribute must have its "exposePublicProps" parameter set to false.',
+                    $attribute->name->getLast(),
+                ))
                     ->identifier('symfonyUX.twigComponent.exposePublicPropsShouldBeFalse')
-                    ->line($asTwigComponent->getLine())
-                    ->tip('Set "exposePublicProps" to false in the #[AsTwigComponent] attribute.')
+                    ->line($attribute->getLine())
+                    ->tip(sprintf(
+                        'Set "exposePublicProps" to false in the #[%s] attribute.',
+                        $attribute->name->getLast()
+                    ))
                     ->build(),
             ];
         }

src/Rules/TwigComponent/ForbiddenAttributesPropertyRule.php

@@ -11,6 +11,7 @@
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -30,19 +31,19 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! $asTwigComponent = AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! $attribute = AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 
-        if (! $attributesVarName = $this->getAttributesVarName($asTwigComponent)) {
+        if (! $attributesVarName = $this->getAttributesVarName($attribute)) {
             return [];
         }
 
         if ($propertyAttributes = $node->getProperty($attributesVarName['name'])) {
             return [
                 RuleErrorBuilder::message(
                     $attributesVarName['custom']
-                        ? sprintf('Using property "%s" in a Twig component is forbidden, it may lead to confusion with the "%s" attribute defined in #[AsTwigComponent].', $attributesVarName['name'], $attributesVarName['name'])
+                        ? sprintf('Using property "%s" in a Twig component is forbidden, it may lead to confusion with the "%s" attribute defined in #[%s].', $attributesVarName['name'], $attributesVarName['name'], $attribute->name->getLast())
                         : sprintf('Using property "%s" in a Twig component is forbidden, it may lead to confusion with the default "attributes" Twig variable.', $attributesVarName['name'])
                 )
                     ->identifier('symfonyUX.twigComponent.forbiddenAttributesProperty')

src/Rules/TwigComponent/ForbiddenClassPropertyRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -24,7 +25,7 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 

src/Rules/TwigComponent/ForbiddenInheritanceRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -24,7 +25,7 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }
 

src/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
 
 /**
@@ -24,7 +25,7 @@ public function getNodeType(): string
 
     public function processNode(Node $node, Scope $scope): array
     {
-        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+        if (! AttributeFinder::findAnyAttribute($node, [AsTwigComponent::class, AsLiveComponent::class])) {
             return [];
         }