Add TwigComponent\ForbiddenClassPropertyRule

Author: Kocal

README.md

@@ -79,3 +79,46 @@ final class Alert
 :+1:
 
 <br>
+
+### ForbiddenClassPropertyRule
+
+Forbid the use of the `$class` property in Twig Components, as it is considered a bad practice to manipulate CSS classes directly in components.
+Use `{{ attributes }}` or `{{ attributes.defaults({ class: '...' }) }}` in your Twig templates instead.
+
+```yaml
+rules:
+    - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ForbiddenClassPropertyRule
+```
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public $class;
+}
+```
+
+:x:
+
+<br>
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+}
+```
+
+:+1:
+
+<br>

src/Rules/TwigComponent/ForbiddenClassPropertyRule.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Rules\TwigComponent;
+
+use Kocal\PHPStanSymfonyUX\NodeAnalyzer\AttributeFinder;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+/**
+ * @implements Rule<Class_>
+ */
+final class ForbiddenClassPropertyRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+            return [];
+        }
+
+        if ($propertyClass = $node->getProperty('class')) {
+            return [
+                RuleErrorBuilder::message('Using a "class" property in a Twig component is forbidden, it is considered as an anti-pattern.')
+                    ->identifier('symfonyUX.twigComponent.forbiddenClassProperty')
+                    ->line($propertyClass->getLine())
+                    ->tip('Consider using {{ attributes }} to automatically render unknown properties as HTML attributes, such as "class". Learn more at https://symfony.com/bundles/ux-twig-component/current/index.html#component-attributes.')
+                    ->build(),
+
+            ];
+        }
+
+        return [];
+    }
+}

tests/Rules/TwigComponent/ForbiddenClassPropertyRule/Fixture/ComponentWithClassProperty.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\ForbiddenClassPropertyRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithClassProperty
+{
+    public $class;
+}

tests/Rules/TwigComponent/ForbiddenClassPropertyRule/Fixture/ComponentWithNoClassProperty.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\ForbiddenClassPropertyRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithNoClassProperty
+{
+}

tests/Rules/TwigComponent/ForbiddenClassPropertyRule/Fixture/NotAComponent.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\ForbiddenClassPropertyRule\Fixture;
+
+final class NotAComponent
+{
+    public $attributes;
+}

tests/Rules/TwigComponent/ForbiddenClassPropertyRule/ForbiddenClassPropertyRuleTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\ForbiddenClassPropertyRule;
+
+use Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ForbiddenClassPropertyRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+final class ForbiddenClassPropertyRuleTest extends RuleTestCase
+{
+    public function testViolations(): void
+    {
+        $this->analyse(
+            [__DIR__ . '/Fixture/ComponentWithClassProperty.php'],
+            [
+                [
+                    'Using a "class" property in a Twig component is forbidden, it is considered as an anti-pattern.',
+                    12,
+                    'Consider using {{ attributes }} to automatically render unknown properties as HTML attributes, such as "class". Learn more at https://symfony.com/bundles/ux-twig-component/current/index.html#component-attributes.',
+                ],
+            ]
+        );
+    }
+
+    public function testNoViolations(): void
+    {
+        $this->analyse(
+            [__DIR__ . '/Fixture/NotAComponent.php'],
+            []
+        );
+        $this->analyse(
+            [__DIR__ . '/Fixture/ComponentWithNoClassProperty.php'],
+            []
+        );
+    }
+
+    protected function getRule(): Rule
+    {
+        return new ForbiddenClassPropertyRule();
+    }
+}