feature #1547 Upgrade to PHPStan 2 (rosier)

This PR was merged into the main branch.

Discussion
----------

Upgrade to PHPStan 2

This PR:
 - Upgrades to PHPStan 2
 - Adds a separate test job for PHPStan
 - Turns off the doctrine rules
 - Merges the config files phpstan.dist.neon and phpstan.neon.dist

I disabled the doctrine rules because all the errors coming from this were basically ignored permanently anyway.

I keep the config file phpstan.dist.neon from the recipe https://github.com/symfony/recipes-contrib/blob/main/phpstan/phpstan/1.0/phpstan.dist.neon and added the rest of the config into that file.

Commits
-------

5dc439e Upgrade to PHPStan 2

.github/workflows/lint.yaml

@@ -45,11 +45,8 @@ jobs:
                   tools: composer:v2
 
             - name: "Install dependencies"
-              run: composer install --ansi --no-interaction --no-progress
-
-            - name: Install PHPUnit
               id: install
-              run: vendor/bin/simple-phpunit install
+              run: composer install --ansi --no-interaction --no-progress
 
             - name: Lint YAML files
               if: always() && steps.install.outcome == 'success'
@@ -83,6 +80,25 @@ jobs:
               if: always() && steps.install.outcome == 'success'
               run: composer audit
 
+    static-analysis:
+        name: PHPStan
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  coverage: none
+                  php-version: '8.3'
+
+            - name: Install dependencies
+              run: composer install --ansi --no-interaction --no-progress
+
+            - name: Install PHPUnit
+              run: vendor/bin/simple-phpunit install
+
             - name: Run PHPStan
-              if: always() && steps.install.outcome == 'success'
-              run: ./vendor/bin/phpstan analyze
+              run: vendor/bin/phpstan analyze --no-progress

composer.json

@@ -54,10 +54,9 @@
     "require-dev": {
         "dama/doctrine-test-bundle": "^8.0.2",
         "doctrine/doctrine-fixtures-bundle": "^3.5",
-        "phpstan/extension-installer": "^1.2",
-        "phpstan/phpstan": "^1.2",
-        "phpstan/phpstan-doctrine": "^1.3",
-        "phpstan/phpstan-symfony": "^1.2",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-doctrine": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "symfony/browser-kit": "^7",
         "symfony/css-selector": "^7",
         "symfony/debug-bundle": "^7",
@@ -70,8 +69,7 @@
     "config": {
         "allow-plugins": {
             "symfony/flex": true,
-            "symfony/runtime": true,
-            "phpstan/extension-installer": true
+            "symfony/runtime": true
         },
         "platform": {
             "php": "8.2.0"

phpstan-baseline.neon

@@ -1,71 +1,7 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Property App\\\\Entity\\\\Comment\\:\\:\\$author type mapping mismatch\\: property can contain App\\\\Entity\\\\User\\|null but database expects App\\\\Entity\\\\User\\.$#"
+			message: '#^Call to function method_exists\(\) with ''Symfony\\\\Component\\\\Dotenv\\\\Dotenv'' and ''bootEnv'' will always evaluate to true\.$#'
+			identifier: function.alreadyNarrowedType
 			count: 1
-			path: src/Entity/Comment.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Comment\\:\\:\\$content type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/Comment.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Comment\\:\\:\\$post type mapping mismatch\\: property can contain App\\\\Entity\\\\Post\\|null but database expects App\\\\Entity\\\\Post\\.$#"
-			count: 1
-			path: src/Entity/Comment.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Post\\:\\:\\$author type mapping mismatch\\: property can contain App\\\\Entity\\\\User\\|null but database expects App\\\\Entity\\\\User\\.$#"
-			count: 1
-			path: src/Entity/Post.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Post\\:\\:\\$content type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/Post.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Post\\:\\:\\$slug type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/Post.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Post\\:\\:\\$summary type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/Post.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\Post\\:\\:\\$title type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/Post.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\User\\:\\:\\$email type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/User.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\User\\:\\:\\$fullName type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/User.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\User\\:\\:\\$password type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/User.php
-
-		-
-			message: "#^Property App\\\\Entity\\\\User\\:\\:\\$username type mapping mismatch\\: property can contain string\\|null but database expects string\\.$#"
-			count: 1
-			path: src/Entity/User.php
-
-		-
-			message: "#^Method App\\\\Entity\\\\User::getUserIdentifier\\(\\) should return non-empty-string but returns string\\.$#"
-			count: 1
-			path: src/Entity/User.php
-
-		-
-			message: "#^Parameter \\#1 \\$function of class ReflectionFunction constructor expects Closure\\|string, callable\\(\\)\\: mixed given\\.$#"
-			count: 1
-			path: src/Twig/SourceCodeExtension.php
+			path: tests/bootstrap.php

phpstan.dist.neon

@@ -1,8 +1,26 @@
+includes:
+    - phpstan-baseline.neon
+    - vendor/phpstan/phpstan-doctrine/extension.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/phpstan/phpstan-symfony/rules.neon
+
 parameters:
+    bootstrapFiles:
+        - vendor/bin/.phpunit/phpunit/vendor/autoload.php
+
+    doctrine:
+        objectManagerLoader: tests/object-manager.php
+
+    ignoreErrors:
+        - identifier: missingType.generics
+
     level: 6
     paths:
-        - bin/
-        - config/
-        - public/
-        - src/
-        - tests/
+        - bin
+        - config
+        - public
+        - src
+        - tests
+
+    symfony:
+        containerXmlPath: var/cache/dev/App_KernelDevDebugContainer.xml

src/Form/Type/DateTimePickerType.php

@@ -49,7 +49,7 @@ public function configureOptions(OptionsResolver $resolver): void
         ]);
     }
 
-    public function getParent(): ?string
+    public function getParent(): string
     {
         return DateTimeType::class;
     }

src/Form/Type/TagsInputType.php

@@ -52,7 +52,7 @@ public function buildView(FormView $view, FormInterface $form, array $options):
         $view->vars['tags'] = $this->tags->findAll();
     }
 
-    public function getParent(): ?string
+    public function getParent(): string
     {
         return TextType::class;
     }

tests/Controller/Admin/BlogControllerTest.php

@@ -110,7 +110,6 @@ public function testAdminNewPost(): void
         /** @var PostRepository $postRepository */
         $postRepository = static::getContainer()->get(PostRepository::class);
 
-        /** @var \App\Entity\Post $post */
         $post = $postRepository->findOneByTitle($postTitle);
 
         $this->assertNotNull($post);

tests/Controller/UserControllerTest.php

@@ -75,7 +75,6 @@ public function testEditUser(): void
 
         $this->assertResponseRedirects('/en/profile/edit', Response::HTTP_SEE_OTHER);
 
-        /** @var User $user */
         $user = $userRepository->findOneByEmail($newUserEmail);
 
         $this->assertNotNull($user);