Add PublicPropertiesShouldBeCamelCaseRule

Author: Kocal

.gitattributes

@@ -2,4 +2,8 @@
 /phpunit.dist.xml export-ignore
 /tests export-ignore
 /.editorconfig export-ignore
-/phpunit.dist.xml
+/AGENTS.md export-ignore
+/ecs.php export-ignore
+/phpstan.dist.neon export-ignore
+/phpstan-baseline.neon export-ignore
+/phpunit.dist.xml export-ignore

README.md

@@ -220,3 +220,62 @@ final class Alert
 :+1:
 
 <br>
+
+### PublicPropertiesShouldBeCamelCaseRule
+
+Enforces that all public properties in Twig Components follow camelCase naming convention.
+This ensures consistency and better integration with Twig templates where properties are passed and accessed using camelCase.
+
+```yaml
+rules:
+    - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\PublicPropertiesShouldBeCamelCaseRule
+```
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public string $user_name;
+    public bool $is_active;
+}
+```
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public string $UserName;
+}
+```
+
+:x:
+
+<br>
+
+```php
+// src/Twig/Components/Alert.php
+namespace App\Twig\Components;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class Alert
+{
+    public string $userName;
+    public bool $isActive;
+}
+```
+
+:+1:
+
+<br>

phpstan-baseline.neon

@@ -0,0 +1,13 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Property Kocal\\PHPStanSymfonyUX\\Tests\\Rules\\TwigComponent\\PublicPropertiesShouldBeCamelCaseRule\\Fixture\\ComponentWithPrivateNonCamelCaseProperties\:\:\$is_active is unused\.$#'
+			identifier: property.unused
+			count: 1
+			path: tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithPrivateNonCamelCaseProperties.php
+
+		-
+			message: '#^Property Kocal\\PHPStanSymfonyUX\\Tests\\Rules\\TwigComponent\\PublicPropertiesShouldBeCamelCaseRule\\Fixture\\ComponentWithPrivateNonCamelCaseProperties\:\:\$user_name is unused\.$#'
+			identifier: property.unused
+			count: 1
+			path: tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithPrivateNonCamelCaseProperties.php

phpstan.dist.neon

@@ -1,3 +1,6 @@
+include:
+    - ./phpstan-baseline.neon
+
 parameters:
     level: max
 

src/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule.php

@@ -0,0 +1,71 @@
+<?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 PublicPropertiesShouldBeCamelCaseRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Class_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! AttributeFinder::findAttribute($node, AsTwigComponent::class)) {
+            return [];
+        }
+
+        $errors = [];
+
+        foreach ($node->getProperties() as $property) {
+            if (! $property->isPublic()) {
+                continue;
+            }
+
+            foreach ($property->props as $prop) {
+                $propertyName = $prop->name->toString();
+
+                if (! $this->isCamelCase($propertyName)) {
+                    $errors[] = RuleErrorBuilder::message(
+                        sprintf('Public property "%s" in a Twig component should be in camelCase.', $propertyName)
+                    )
+                        ->identifier('symfonyUX.twigComponent.publicPropertiesShouldBeCamelCase')
+                        ->line($property->getLine())
+                        ->tip(sprintf('Consider renaming "%s" to "%s".', $propertyName, $this->toCamelCase($propertyName)))
+                        ->build();
+                }
+            }
+        }
+
+        return $errors;
+    }
+
+    private function isCamelCase(string $name): bool
+    {
+        // Property should start with a lowercase letter and contain no underscores
+        return preg_match('/^[a-z][a-zA-Z0-9]*$/', $name) === 1;
+    }
+
+    private function toCamelCase(string $name): string
+    {
+        // Convert snake_case or PascalCase to camelCase
+        $name = str_replace('_', ' ', $name);
+        $name = ucwords($name);
+        $name = str_replace(' ', '', $name);
+
+        return lcfirst($name);
+    }
+}

tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithCamelCaseProperties.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\PublicPropertiesShouldBeCamelCaseRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithCamelCaseProperties
+{
+    public string $userName;
+
+    public bool $isActive;
+
+    public int $count;
+}

tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithPascalCaseProperty.php

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

tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithPrivateNonCamelCaseProperties.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\PublicPropertiesShouldBeCamelCaseRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithPrivateNonCamelCaseProperties
+{
+    public string $validProperty;
+
+    private string $user_name;
+
+    private bool $is_active;
+}

tests/Rules/TwigComponent/PublicPropertiesShouldBeCamelCaseRule/Fixture/ComponentWithSnakeCaseProperty.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\PublicPropertiesShouldBeCamelCaseRule\Fixture;
+
+use Symfony\UX\TwigComponent\Attribute\AsTwigComponent;
+
+#[AsTwigComponent]
+final class ComponentWithSnakeCaseProperty
+{
+    public string $user_name;
+
+    public bool $is_active;
+}

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

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kocal\PHPStanSymfonyUX\Tests\Rules\TwigComponent\PublicPropertiesShouldBeCamelCaseRule\Fixture;
+
+final class NotAComponent
+{
+    public string $user_name;
+
+    public bool $is_active;
+}