Merge pull request #13 from Kocal/extension-neon

Author: Kocal

README.md

@@ -10,11 +10,18 @@ To install the PHPStan rules for Symfony UX, you can use Composer:
 composer require --dev kocal/phpstan-symfony-ux
 ```
 
-## Configuration
+If you have [phpstan/extension-installer](https://github.com/phpstan/extension-installer) installed (which is the case by default), the extension will be automatically registered and you're ready to go.
+
+If you don't use the extension installer, you'll need to manually add the extension to your `phpstan.neon` or `phpstan.dist.neon` configuration file:
+
+```yaml
+includes:
+    - vendor/kocal/phpstan-symfony-ux/extension.neon
+```
 
-After installing the package, you need to configure PHPStan to use the rules.
+## Configuration
 
-Each rule can be enabled individually by adding it to your `phpstan.dist.neon` configuration file.
+Each rule can be enabled individually by adding it to your `phpstan.neon` or `phpstan.dist.neon` configuration file.
 
 ## LiveComponent Rules
 

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "kocal/phpstan-symfony-ux",
     "description": "PHPStan rules for Symfony UX",
-    "type": "library",
+    "type": "phpstan-extension",
     "license": "MIT",
     "authors": [
         {
@@ -40,8 +40,18 @@
         "symfony/ux-twig-component": "^2.0",
         "symplify/easy-coding-standard": "^13.0"
     },
+    "extra": {
+        "phpstan": {
+            "includes": [
+                "extension.neon"
+            ]
+        }
+    },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     },
     "minimum-stability": "dev",
     "prefer-stable": true

extension.neon

@@ -0,0 +1,3 @@
+# This file is intentionally empty for backward compatibility purposes.
+# Rules must be enabled individually in your phpstan.neon configuration.
+# See README.md for available rules and their configuration.

tests/Rules/LiveComponent/LiveActionMethodsShouldBePublicRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\LiveComponent\LiveActionMethodsShouldBePublicRule

tests/Rules/TwigComponent/ClassMustBeFinalRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ClassMustBeFinalRule

tests/Rules/TwigComponent/ClassNameShouldNotEndWithComponentRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ClassNameShouldNotEndWithComponentRule

tests/Rules/TwigComponent/ExposePublicPropsShouldBeFalseRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ExposePublicPropsShouldBeFalseRule

tests/Rules/TwigComponent/ForbiddenAttributesPropertyRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ForbiddenAttributesPropertyRule

tests/Rules/TwigComponent/ForbiddenClassPropertyRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\ForbiddenClassPropertyRule

tests/Rules/TwigComponent/MethodsShouldBePublicOrPrivateRule/config/configured_rule.neon

@@ -1,2 +1,5 @@
+includes:
+    - ../../../../test-extension.neon
+
 rules:
     - Kocal\PHPStanSymfonyUX\Rules\TwigComponent\MethodsShouldBePublicOrPrivateRule