[DependencyInjection] Include return type in AppReference shape

Author: nicolas-grekas

DependencyInjection/Compiler/PhpConfigReferenceDumpPass.php

@@ -60,11 +60,11 @@ public static function config(array $config): array
 
     private const WHEN_ENV_APP_TEMPLATE = <<<'PHPDOC'
 
-             *     "when@{ENV}"?: array{
-             *         imports?: ImportsConfig,
-             *         parameters?: ParametersConfig,
-             *         services?: ServicesConfig,{SHAPE}
-             *     },
+         *     "when@{ENV}"?: array{
+         *         imports?: ImportsConfig,
+         *         parameters?: ParametersConfig,
+         *         services?: ServicesConfig,{SHAPE}
+         *     },
         PHPDOC;
 
     private const ROUTES_TYPES_TEMPLATE = <<<'PHPDOC'
@@ -121,23 +121,24 @@ public function process(ContainerBuilder $container): void
 
         $r = new \ReflectionClass(AppReference::class);
 
-        if (false === $i = strpos($phpdoc = $r->getDocComment(), "\n */")) {
+        if (false === $i = strpos($phpdoc = $r->getDocComment(), "\n * @psalm-type ConfigType = ")) {
             throw new \LogicException(\sprintf('Cannot insert config shape in "%s".', AppReference::class));
         }
         $appTypes = substr_replace($phpdoc, $appTypes, $i, 0);
 
-        if (false === $i = strpos($phpdoc = $r->getMethod('config')->getDocComment(), "\n     *     ...<string, ExtensionType|array{")) {
+        if (false === $i = strrpos($phpdoc = $appTypes, "\n *     ...<string, ExtensionType|array{")) {
             throw new \LogicException(\sprintf('Cannot insert config shape in "%s".', AppReference::class));
         }
-        $appParam = substr_replace($phpdoc, $this->getShapeForExtensions($anyEnvExtensions, $container), $i, 0);
-        $i += \strlen($appParam) - \strlen($phpdoc);
+        $appTypes = substr_replace($phpdoc, $this->getShapeForExtensions($anyEnvExtensions, $container), $i, 0);
+        $i += \strlen($appTypes) - \strlen($phpdoc);
 
         foreach ($extensionsPerEnv as $env => $extensions) {
-            $appParam = substr_replace($appParam, strtr(self::WHEN_ENV_APP_TEMPLATE, [
+            $appTypes = substr_replace($appTypes, strtr(self::WHEN_ENV_APP_TEMPLATE, [
                 '{ENV}' => $env,
                 '{SHAPE}' => $this->getShapeForExtensions($extensions, $container, '    '),
             ]), $i, 0);
         }
+        $appParam = $r->getMethod('config')->getDocComment();
 
         $r = new \ReflectionClass(RoutesReference::class);
 
@@ -191,7 +192,7 @@ private function getShapeForExtensions(array $extensions, ContainerBuilder $cont
         foreach ($extensions as $extension) {
             if ($this->getConfiguration($extension, $container)) {
                 $type = $this->camelCase($extension->getAlias()).'Config';
-                $shape .= \sprintf("\n     *     %s%s?: %s,", $indent, $extension->getAlias(), $type);
+                $shape .= \sprintf("\n *     %s%s?: %s,", $indent, $extension->getAlias(), $type);
             }
         }
 

Tests/Fixtures/reference.php

@@ -130,40 +130,43 @@
  *         count?: int,
  *     },
  * }
+ * @psalm-type ConfigType = array{
+ *     imports?: ImportsConfig,
+ *     parameters?: ParametersConfig,
+ *     services?: ServicesConfig,
+ *     test?: TestConfig,
+ *     "when@dev"?: array{
+ *         imports?: ImportsConfig,
+ *         parameters?: ParametersConfig,
+ *         services?: ServicesConfig,
+ *         test?: TestConfig,
+ *     },
+ *     "when@prod"?: array{
+ *         imports?: ImportsConfig,
+ *         parameters?: ParametersConfig,
+ *         services?: ServicesConfig,
+ *         test?: TestConfig,
+ *     },
+ *     "when@test"?: array{
+ *         imports?: ImportsConfig,
+ *         parameters?: ParametersConfig,
+ *         services?: ServicesConfig,
+ *         test?: TestConfig,
+ *     },
+ *     ...<string, ExtensionType|array{ // extra keys must follow the when@%env% pattern or match an extension alias
+ *         imports?: ImportsConfig,
+ *         parameters?: ParametersConfig,
+ *         services?: ServicesConfig,
+ *         ...<string, ExtensionType>,
+ *     }>
+ * }
  */
 final class App extends AppReference
 {
     /**
-     * @param array{
-     *     imports?: ImportsConfig,
-     *     parameters?: ParametersConfig,
-     *     services?: ServicesConfig,
-     *     test?: TestConfig,
-     *     "when@dev"?: array{
-     *         imports?: ImportsConfig,
-     *         parameters?: ParametersConfig,
-     *         services?: ServicesConfig,
-     *         test?: TestConfig,
-     *     },
-     *     "when@prod"?: array{
-     *         imports?: ImportsConfig,
-     *         parameters?: ParametersConfig,
-     *         services?: ServicesConfig,
-     *         test?: TestConfig,
-     *     },
-     *     "when@test"?: array{
-     *         imports?: ImportsConfig,
-     *         parameters?: ParametersConfig,
-     *         services?: ServicesConfig,
-     *         test?: TestConfig,
-     *     },
-     *     ...<string, ExtensionType|array{ // extra keys must follow the when@%env% pattern or match an extension alias
-     *         imports?: ImportsConfig,
-     *         parameters?: ParametersConfig,
-     *         services?: ServicesConfig,
-     *         ...<string, ExtensionType>,
-     *     }>
-     * } $config
+     * @param ConfigType $config
+     *
+     * @psalm-return ConfigType
      */
     public static function config(array $config): array
     {