Merge pull request #16 from 21TORR/doctrine-dql

Improve PHPStan support of Doctrine DQL + ignore Storybloks story return types

CHANGELOG.md

@@ -1,3 +1,10 @@
+1.3.5
+=====
+
+* (improvement) Add proper support for DQL types in PHPStan Doctrine.
+* (improvement) Ignore return type of Storyblok stories for now.
+
+
 1.3.4
 =====
 

_init/symfony/phpstan.neon

@@ -1,8 +1,12 @@
 includes:
 	- vendor/21torr/janus/phpstan/symfony.neon
 
+
+parameters:
+	doctrine:
+		objectManagerLoader: tests/phpstan-doctrine-object-manager.php
+
 # If you use simple-phpunit, you need to uncomment the following line.
 # Always make sure to first run simple-phpunit and then PHPStan.
-# parameters:
 #	bootstrapFiles:
 #		- vendor/bin/.phpunit/phpunit/vendor/autoload.php

_init/symfony/tests/phpstan-doctrine-object-manager.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+use App\Kernel;
+use Symfony\Component\Dotenv\Dotenv;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+(new Dotenv())->bootEnv(__DIR__ . '/../.env');
+
+$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
+$kernel->boot();
+
+return $kernel->getContainer()->get('doctrine')->getManager();

phpstan.neon

@@ -1,2 +1,7 @@
 includes:
-    - phpstan/lib.neon
+	- phpstan/lib.neon
+
+parameters:
+	excludePaths:
+		analyseAndScan:
+			- _init/symfony/tests/phpstan-doctrine-object-manager.php

phpstan/symfony.neon

@@ -4,3 +4,13 @@ includes:
 parameters:
 	symfony:
 		container_xml_path: %currentWorkingDirectory%/var/cache/dev/App_KernelDevDebugContainer.xml
+
+	ignoreErrors:
+		# We will always have the issue, that the type of the prop and the database type won't match,
+		# as we validate in between and PHPStan can't know that. So let's just deactivate it.
+		- identifier: doctrine.columnType
+
+		# Let's ignore return types of Storyblok stories for now
+		-
+			identifier: return.type
+			path: %currentWorkingDirectory%/src/Storyblok/Component/*Story.php

src/Initializer/InitializeHelper.php

@@ -157,7 +157,7 @@ public function runComposerInProject (array $cmd) : void
 	 */
 	public function runProcessInProject (array $cmd) : void
 	{
-		$this->io->writeln(sprintf(
+		$this->io->writeln(\sprintf(
 			"$> Running command <fg=blue>%s</>",
 			implode(" ", $cmd),
 		));
@@ -168,12 +168,12 @@ public function runProcessInProject (array $cmd) : void
 		);
 		$process->mustRun();
 
-		$output = trim(sprintf("%s\n%s", $process->getErrorOutput(), $process->getOutput()));
+		$output = trim(\sprintf("%s\n%s", $process->getErrorOutput(), $process->getOutput()));
 
 		if ("" !== $output)
 		{
 			$this->io->block(
-				trim(sprintf("%s\n%s", $process->getErrorOutput(), $process->getOutput())),
+				trim(\sprintf("%s\n%s", $process->getErrorOutput(), $process->getOutput())),
 				prefix: "  │  ",
 			);
 		}