Add PHPStan on level 5

.github/workflows/workflow.yaml

@@ -27,6 +27,10 @@ jobs:
         run: |
           docker run --rm php-ci vendor/bin/ecs --config=development/tooling/ecs.php
 
+      - name: Run PHPStan
+        run: |
+          docker run --rm php-ci vendor/bin/phpstan --configuration=./development/tooling/phpstan.neon
+
       - name: Run unit tests
         run: |
           docker run --rm php-ci vendor/bin/phpunit -c development/tooling/phpunit.xml  --testdox tests

Taskfile

@@ -53,6 +53,10 @@ function task:codestyle { ## Run codestyle test
 	dockercompose-exec vendor/bin/ecs --config=development/tooling/ecs.php
 }
 
+function task:phpstan { ## Run PHPStan
+  dockercompose-exec vendor/bin/phpstan --configuration=./development/tooling/phpstan.neon
+}
+
 function task:tests { ## Run unit tests
 	dockercompose-exec vendor/bin/phpunit -c development/tooling/phpunit.xml --testdox tests
 }

composer.json

@@ -8,7 +8,10 @@
     },
     "require-dev": {
         "symplify/easy-coding-standard": "^12.5",
-        "phpunit/phpunit": "^11"
+        "phpunit/phpunit": "^11",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
+        "phpstan/phpstan-doctrine": "^2.0"
     },
     "license": "MIT",
     "autoload": {

development/tooling/phpstan.neon

@@ -0,0 +1,20 @@
+parameters:
+    level: 5
+    paths:
+        - ../../src
+        - ../../tests
+    ignoreErrors:
+### Ignore all Symfony/Doctrine errors
+        - '#Symfony\\.*#'
+        - '#Doctrine\\.*#'
+### Ignore warning about unused traits
+        - '#Trait .* is used zero times and is not analysed\.#'
+### Exclude some paths with Symfony specific things
+    excludePaths:
+        - ../../src/EventListener/DoctrineMetadataListener.php
+        - ../../src/Form
+        - ../../src/Repository
+includes:
+    - ../../vendor/phpstan/phpstan-symfony/extension.neon
+    - ../../vendor/phpstan/phpstan-symfony/rules.neon
+    - ../../vendor/phpstan/phpstan-doctrine/extension.neon

src/Repository/UserAgreementRepository.php

@@ -4,7 +4,7 @@
 
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\Persistence\ManagerRegistry;
-use UserAgreements\Entity\UserAgreement;
+use RobertvanLienden\UserAgreements\Entity\UserAgreement;
 
 /**
  * @extends ServiceEntityRepository<UserAgreement>

tests/unit/AgreementServiceTest.php

@@ -32,7 +32,6 @@ public function testGetAgreements(): void
     {
         $agreements = $this->agreementService->getAgreements();
 
-        $this->assertIsArray($agreements);
         $this->assertCount(2, $agreements);
         $this->assertArrayHasKey('label', $agreements[0]);
         $this->assertArrayHasKey('content', $agreements[0]);