bug #60400 [Config] Fix generated comment for multiline "info" (GromNaN)

fabpot · fabpot · commit 7a69d610e3cc · 2025-05-14T08:00:12.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Config] Fix generated comment for multiline "info" | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #60317 | License | MIT Instead of fixing the multiline comment formatting only for the "info" part, the `* ` is now prepended to every line of the generated comment block. `nette/code-generator` uses almost the same transformation: https://github.com/nette/php-generator/blob/42806049a7774a2bd316c958f5dcf01c6b5c56fa/src/PhpGenerator/Helpers.php#L60 Commits ------- 941c051 [Config] Fix generated comment for multiline "info"
diff --git a/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php b/src/Symfony/Component/Config/Builder/ConfigBuilderGenerator.php
@@ -413,39 +413,39 @@ private function getComment(BaseNode $node): string
     {
         $comment = '';
         if ('' !== $info = (string) $node->getInfo()) {
-            $comment .= ' * '.$info."\n";
+            $comment .= $info."\n";
         }
 
         if (!$node instanceof ArrayNode) {
             foreach ((array) ($node->getExample() ?? []) as $example) {
-                $comment .= ' * @example '.$example."\n";
+                $comment .= '@example '.$example."\n";
             }
 
             if ('' !== $default = $node->getDefaultValue()) {
-                $comment .= ' * @default '.(null === $default ? 'null' : var_export($default, true))."\n";
+                $comment .= '@default '.(null === $default ? 'null' : var_export($default, true))."\n";
             }
 
             if ($node instanceof EnumNode) {
-                $comment .= sprintf(' * @param ParamConfigurator|%s $value', implode('|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n";
+                $comment .= sprintf('@param ParamConfigurator|%s $value', implode('|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n";
             } else {
                 $parameterTypes = $this->getParameterTypes($node);
-                $comment .= ' * @param ParamConfigurator|'.implode('|', $parameterTypes).' $value'."\n";
+                $comment .= '@param ParamConfigurator|'.implode('|', $parameterTypes).' $value'."\n";
             }
         } else {
             foreach ((array) ($node->getExample() ?? []) as $example) {
-                $comment .= ' * @example '.json_encode($example)."\n";
+                $comment .= '@example '.json_encode($example)."\n";
             }
 
             if ($node->hasDefaultValue() && [] != $default = $node->getDefaultValue()) {
-                $comment .= ' * @default '.json_encode($default)."\n";
+                $comment .= '@default '.json_encode($default)."\n";
             }
         }
 
         if ($node->isDeprecated()) {
-            $comment .= ' * @deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n";
+            $comment .= '@deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n";
         }
 
-        return $comment;
+        return $comment ? ' * '.str_replace("\n", "\n * ", rtrim($comment, "\n"))."\n" : '';
     }
 
     /**
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/NodeInitialValues.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/NodeInitialValues.php
@@ -38,7 +38,13 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->arrayPrototype()
                                 ->fixXmlConfig('option')
                                 ->children()
-                                    ->scalarNode('dsn')->end()
+                                    ->scalarNode('dsn')
+                                        ->info(<<<'INFO'
+                                            The DSN to use. This is a required option.
+                                            The info is used to describe the DSN,
+                                            it can be multi-line.
+                                            INFO)
+                                        ->end()
                                     ->scalarNode('serializer')->defaultNull()->end()
                                     ->arrayNode('options')
                                         ->normalizeKeys(false)
diff --git a/src/Symfony/Component/Config/Tests/Builder/Fixtures/NodeInitialValues/Symfony/Config/NodeInitialValues/Messenger/TransportsConfig.php b/src/Symfony/Component/Config/Tests/Builder/Fixtures/NodeInitialValues/Symfony/Config/NodeInitialValues/Messenger/TransportsConfig.php
@@ -16,6 +16,9 @@ class TransportsConfig
     private $_usedProperties = [];
 
     /**
+     * The DSN to use. This is a required option.
+     * The info is used to describe the DSN,
+     * it can be multi-line.
      * @default null
      * @param ParamConfigurator|mixed $value
      * @return $this

Original file line number	Diff line number	Diff line change
`@@ -413,39 +413,39 @@ private function getComment(BaseNode $node): string`
`413`	`413`	`{`
`414`	`414`	`$comment = '';`
`415`	`415`	`if ('' !== $info = (string) $node->getInfo()) {`
`416`		`- $comment .= ' * '.$info."\n";`
	`416`	`+ $comment .= $info."\n";`
`417`	`417`	`}`
`418`	`418`
`419`	`419`	`if (!$node instanceof ArrayNode) {`
`420`	`420`	`foreach ((array) ($node->getExample() ?? []) as $example) {`
`421`		`- $comment .= ' * @example '.$example."\n";`
	`421`	`+ $comment .= '@example '.$example."\n";`
`422`	`422`	`}`
`423`	`423`
`424`	`424`	`if ('' !== $default = $node->getDefaultValue()) {`
`425`		`- $comment .= ' * @default '.(null === $default ? 'null' : var_export($default, true))."\n";`
	`425`	`+ $comment .= '@default '.(null === $default ? 'null' : var_export($default, true))."\n";`
`426`	`426`	`}`
`427`	`427`
`428`	`428`	`if ($node instanceof EnumNode) {`
`429`		`- $comment .= sprintf(' * @param ParamConfigurator\|%s $value', implode('\|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n";`
	`429`	`+ $comment .= sprintf('@param ParamConfigurator\|%s $value', implode('\|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n";`
`430`	`430`	`} else {`
`431`	`431`	`$parameterTypes = $this->getParameterTypes($node);`
`432`		`- $comment .= ' * @param ParamConfigurator\|'.implode('\|', $parameterTypes).' $value'."\n";`
	`432`	`+ $comment .= '@param ParamConfigurator\|'.implode('\|', $parameterTypes).' $value'."\n";`
`433`	`433`	`}`
`434`	`434`	`} else {`
`435`	`435`	`foreach ((array) ($node->getExample() ?? []) as $example) {`
`436`		`- $comment .= ' * @example '.json_encode($example)."\n";`
	`436`	`+ $comment .= '@example '.json_encode($example)."\n";`
`437`	`437`	`}`
`438`	`438`
`439`	`439`	`if ($node->hasDefaultValue() && [] != $default = $node->getDefaultValue()) {`
`440`		`- $comment .= ' * @default '.json_encode($default)."\n";`
	`440`	`+ $comment .= '@default '.json_encode($default)."\n";`
`441`	`441`	`}`
`442`	`442`	`}`
`443`	`443`
`444`	`444`	`if ($node->isDeprecated()) {`
`445`		`- $comment .= ' * @deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n";`
	`445`	`+ $comment .= '@deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n";`
`446`	`446`	`}`
`447`	`447`
`448`		`- return $comment;`
	`448`	`+ return $comment ? ' * '.str_replace("\n", "\n * ", rtrim($comment, "\n"))."\n" : '';`
`449`	`449`	`}`
`450`	`450`
`451`	`451`	`/**`