Drop Psalm in favor of PHPStan

As per the decision we made during the hackathon.
I have left many psalm-suppress annotations that seem informative in the
codebase.

.gitattributes

@@ -4,7 +4,8 @@
 .gitignore             export-ignore
 phpunit.xml.dist       export-ignore
 phpcs.xml.dist         export-ignore
-psalm.xml.dist         export-ignore
+phpstan-baseline.neon  export-ignore
+phpstan.neon.dist      export-ignore
 /docs                  export-ignore
 /tests                 export-ignore
 .symfony.bundle.yaml   export-ignore

.github/workflows/static-analysis.yml

@@ -10,25 +10,6 @@ on:
       - "*.x"
 
 jobs:
-  static-analysis-psalm:
-    name: "Static Analysis with Psalm"
-    runs-on: "ubuntu-latest"
-
-    steps:
-      - name: "Checkout code"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "8.2"
-
-      - name: "Enforce using stable dependencies"
-        run: "composer config minimum-stability stable"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-
-      - name: "Run a static analysis with vimeo/psalm"
-        run: "vendor/bin/psalm --show-info=false --stats --output-format=github --find-unused-psalm-suppress"
+  static-analysis:
+    name: "Static Analysis"
+    uses: "doctrine/.github/.github/workflows/[email protected]"

composer.json

@@ -50,9 +50,10 @@
         "doctrine/deprecations": "^1.0",
         "doctrine/orm": "^2.17 || ^3.0",
         "friendsofphp/proxy-manager-lts": "^1.0",
+        "phpstan/phpstan": "2.1.1",
+        "phpstan/phpstan-phpunit": "2.0.3",
+        "phpstan/phpstan-strict-rules": "^2",
         "phpunit/phpunit": "^9.5.26",
-        "psalm/plugin-phpunit": "^0.18.4",
-        "psalm/plugin-symfony": "^5",
         "psr/log": "^1.1.4 || ^2.0 || ^3.0",
         "symfony/phpunit-bridge": "^6.1 || ^7.0",
         "symfony/property-info": "^5.4 || ^6.0 || ^7.0",
@@ -65,8 +66,7 @@
         "symfony/var-exporter": "^5.4 || ^6.2 || ^7.0",
         "symfony/web-profiler-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/yaml": "^5.4 || ^6.0 || ^7.0",
-        "twig/twig": "^1.34 || ^2.12 || ^3.0",
-        "vimeo/psalm": "^5.15"
+        "twig/twig": "^1.34 || ^2.12 || ^3.0"
     },
     "conflict": {
         "doctrine/annotations": ">=3.0",

phpstan.neon.dist

@@ -0,0 +1,9 @@
+parameters:
+   level: 1
+   paths:
+      - src
+      - tests
+
+   excludePaths:
+      - src/Command/Proxy/ConvertMappingDoctrineCommand.php
+      - src/Command/Proxy/EnsureProductionSettingsDoctrineCommand.php

src/Command/CreateDatabaseDoctrineCommand.php

@@ -63,6 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         // Need to get rid of _every_ occurrence of dbname from connection configuration as we have already extracted all relevant info from url
         /** @psalm-suppress InvalidArrayOffset Need to be compatible with DBAL < 4, which still has `$params['url']` */
+        /** @phpstan-ignore unset.offset */
         unset($params['dbname'], $params['path'], $params['url']);
 
         if ($connection->getDatabasePlatform() instanceof PostgreSQLPlatform) {

src/Command/DoctrineCommand.php

@@ -34,6 +34,7 @@ public function __construct(ManagerRegistry $doctrine)
      */
     protected function getEntityGenerator()
     {
+        /** @phpstan-ignore class.notFound */
         $entityGenerator = new EntityGenerator();
         $entityGenerator->setGenerateAnnotations(false);
         $entityGenerator->setGenerateStubMethods(true);

src/Command/DropDatabaseDoctrineCommand.php

@@ -74,6 +74,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         /** @psalm-suppress InvalidArrayOffset Need to be compatible with DBAL < 4, which still has `$params['url']` */
+        /* @phpstan-ignore unset.offset */
         unset($params['dbname'], $params['url']);
 
         if ($connection->getDatabasePlatform() instanceof PostgreSQLPlatform) {

src/Command/ImportMappingDoctrineCommand.php

@@ -109,6 +109,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
+        /* @phpstan-ignore class.notFound */
         $cme      = new ClassMetadataExporter();
         $exporter = $cme->getExporter($type);
         $exporter->setOverwriteExistingFiles($input->getOption('force'));
@@ -126,6 +127,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $emName = $input->getOption('em');
         $emName = $emName ? $emName : 'default';
 
+        /* @phpstan-ignore class.notFound */
         $cmf = new DisconnectedClassMetadataFactory();
         $cmf->setEntityManager($em);
         $metadata = $cmf->getAllMetadata();

src/Command/Proxy/DoctrineCommandHelper.php

@@ -29,12 +29,14 @@ public static function setApplicationEntityManager(Application $application, $em
         assert($em instanceof EntityManagerInterface);
         $helperSet = $application->getHelperSet();
         /** @psalm-suppress InvalidArgument ORM < 3 specific */
+        /* @phpstan-ignore class.notFound */
         $helperSet->set(new EntityManagerHelper($em), 'em');
 
         trigger_deprecation(
             'doctrine/doctrine-bundle',
             '2.7',
             'Providing an EntityManager using "%s" is deprecated. Use an instance of "%s" instead.',
+            /* @phpstan-ignore class.notFound */
             EntityManagerHelper::class,
             EntityManagerProvider::class,
         );

src/ConnectionFactory.php

@@ -28,7 +28,7 @@
 
 use const PHP_EOL;
 
-/** @psalm-import-type Params from DriverManager */
+/** @phpstan-import-type Params from DriverManager */
 class ConnectionFactory
 {
     /** @internal */
@@ -63,7 +63,7 @@ public function __construct(array $typesConfig, ?DsnParser $dsnParser = null)
      *
      * @param mixed[]               $params
      * @param array<string, string> $mappingTypes
-     * @psalm-param Params $params
+     * @phpstan-param Params $params
      *
      * @return Connection
      */
@@ -108,6 +108,7 @@ public function createConnection(array $params, ?Configuration $config = null, ?
                         throw InvalidWrapperClass::new($params['wrapperClass']);
                     }
 
+                    /* @phpstan-ignore staticMethod.notFound */
                     throw DBALException::invalidWrapperClass($params['wrapperClass']);
                 }
 
@@ -186,6 +187,7 @@ private function getDatabasePlatform(Connection $connection): AbstractPlatform
         } catch (DriverException $driverException) {
             $class = class_exists(DBALException::class) ? DBALException::class : ConnectionException::class;
 
+            /* @phpstan-ignore new.interface */
             throw new $class(
                 'An exception occurred while establishing a connection to figure out your platform version.' . PHP_EOL .
                 "You can circumvent this by setting a 'server_version' configuration value" . PHP_EOL . PHP_EOL .
@@ -244,11 +246,11 @@ private function addDatabaseSuffix(array $params): array
      * updated list of parameters.
      *
      * @param mixed[] $params The list of parameters.
-     * @psalm-param Params $params
+     * @phpstan-param Params $params
      *
      * @return mixed[] A modified list of parameters with info from a database
      *                 URL extracted into individual parameter parts.
-     * @psalm-return Params
+     * @phpstan-return Params
      *
      * @throws DBALException
      */

src/DataCollector/DoctrineDataCollector.php

@@ -24,15 +24,15 @@
 use function usort;
 
 /**
- * @psalm-type QueryType = array{
+ * @phpstan-type QueryType = array{
  *    executionMS: float,
  *    explainable: bool,
  *    sql: string,
  *    params: ?array<array-key, mixed>,
  *    runnable: bool,
  *    types: ?array<array-key, Type|int|string|null>,
  * }
- * @psalm-type DataType = array{
+ * @phpstan-type DataType = array{
  *    caches: array{
  *       enabled: bool,
  *       counts: array<"puts"|"hits"|"misses", int>,
@@ -54,7 +54,7 @@ class DoctrineDataCollector extends BaseCollector
 
     /**
      * @var mixed[][]|null
-     * @psalm-var ?array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
+     * @phpstan-var ?array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
      */
     private ?array $groupedQueries = null;
 
@@ -216,7 +216,7 @@ public function getCacheEnabled()
 
     /**
      * @return array<string, array<string, int>>
-     * @psalm-return array<"puts"|"hits"|"misses", array<string, int>>
+     * @phpstan-return array<"puts"|"hits"|"misses", array<string, int>>
      */
     public function getCacheRegions()
     {
@@ -237,7 +237,7 @@ public function getInvalidEntityCount()
 
     /**
      * @return string[][]
-     * @psalm-return array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
+     * @phpstan-return array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
      */
     public function getGroupedQueries()
     {

src/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php

@@ -89,7 +89,8 @@ public static function createXmlMappingDriver(array $namespaces, array $managerP
     public static function createYamlMappingDriver(array $namespaces, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [])
     {
         $locator = new Definition(SymfonyFileLocator::class, [$namespaces, '.orm.yml']);
-        $driver  = new Definition(YamlDriver::class, [$locator]);
+        /* @phpstan-ignore class.notFound */
+        $driver = new Definition(YamlDriver::class, [$locator]);
 
         return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);
     }
@@ -133,6 +134,7 @@ public static function createPhpMappingDriver(array $namespaces, array $managerP
     public static function createAnnotationMappingDriver(array $namespaces, array $directories, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [], bool $reportFieldsWhereDeclared = false)
     {
         $reader = new Reference('annotation_reader');
+        /* @phpstan-ignore class.notFound */
         $driver = new Definition(AnnotationDriver::class, [$reader, $directories, $reportFieldsWhereDeclared]);
 
         return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);

src/DependencyInjection/DoctrineExtension.php

@@ -91,7 +91,7 @@
  * DoctrineExtension is an extension for the Doctrine DBAL and ORM library.
  *
  * @final since 2.9
- * @psalm-type DBALConfig = array{
+ * @phpstan-type DBALConfig = array{
  *      connections: array<string, array{logging: bool, profiling: bool, profiling_collect_backtrace: bool, idle_connection_ttl: int}>,
  *      driver_schemes: array<string, string>,
  *      default_connection: string,
@@ -579,7 +579,6 @@ protected function ormLoad(array $config, ContainerBuilder $container)
 
         $entityManagers = [];
         foreach (array_keys($config['entity_managers']) as $name) {
-            /** @psalm-suppress InvalidArrayOffset */
             $entityManagers[$name] = sprintf('doctrine.orm.%s_entity_manager', $name);
         }
 
@@ -1186,12 +1185,15 @@ protected function getMetadataDriverClass(string $driverType): string
                 return SimplifiedXmlDriver::class;
 
             case 'yml':
+                /* @phpstan-ignore class.notFound */
                 return SimplifiedYamlDriver::class;
 
             case 'php':
+                /* @phpstan-ignore class.notFound */
                 return class_exists(PHPDriver::class) ? PHPDriver::class : LegacyPHPDriver::class;
 
             case 'staticphp':
+                /* @phpstan-ignore class.notFound */
                 return class_exists(StaticPHPDriver::class) ? StaticPHPDriver::class : LegacyStaticPHPDriver::class;
 
             case 'attribute':

src/Mapping/DisconnectedMetadataFactory.php

@@ -146,6 +146,7 @@ private function getMetadataForNamespace(string $namespace): ClassMetadataCollec
     private function getMetadataForClass(string $entity): ClassMetadataCollection
     {
         foreach ($this->registry->getManagers() as $em) {
+            /* @phpstan-ignore class.notFound */
             $cmf = new DisconnectedClassMetadataFactory();
             $cmf->setEntityManager($em);
 
@@ -162,6 +163,7 @@ private function getAllMetadata(): array
     {
         $metadata = [];
         foreach ($this->registry->getManagers() as $em) {
+            /* @phpstan-ignore class.notFound */
             $cmf = new DisconnectedClassMetadataFactory();
             $cmf->setEntityManager($em);
             foreach ($cmf->getAllMetadata() as $m) {

src/Middleware/BacktraceDebugDataHolder.php

@@ -11,7 +11,6 @@
 
 use const DEBUG_BACKTRACE_IGNORE_ARGS;
 
-/** @psalm-suppress MissingDependency */
 class BacktraceDebugDataHolder extends DebugDataHolder
 {
     /** @var string[] */

src/Middleware/DebugMiddleware.php

@@ -27,7 +27,6 @@ public function setConnectionName(string $name): void
 
     public function wrap(DriverInterface $driver): DriverInterface
     {
-        /** @psalm-suppress InternalClass,InternalMethod */
         return new Driver($driver, $this->debugDataHolder, $this->stopwatch, $this->connectionName);
     }
 }

src/Registry.php

@@ -53,10 +53,12 @@ public function getAliasNamespace($alias)
             try {
                 /** @psalm-suppress UndefinedMethod ORM < 3 specific */
                 return $objectManager->getConfiguration()->getEntityNamespace($alias);
+            /* @phpstan-ignore class.notFound */
             } catch (ORMException $e) {
             }
         }
 
+        /* @phpstan-ignore class.notFound */
         throw ORMException::unknownEntityNamespace($alias);
     }