[Config] Fix generated comment for multiline "info" #60400
Merged
+19
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GromNaN
commented
May 11, 2025
| } | ||
|
|
||
| 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"; |
There was a problem hiding this comment.
When up-merging into 7.2, a backslash is added before sprintf by 6ce530c#diff-2aaa94a5e0cdde514853eddaf724fb3724c0501ddc5285af115bc1fe9c04d7ce
GromNaN
commented
May 11, 2025
| @@ -413,39 +413,43 @@ private function getComment(BaseNode $node): string | |||
| { | |||
| $comment = ''; | |||
| if ('' !== $info = (string) $node->getInfo()) { | |||
| $comment .= ' * '.$info."\n"; | |||
| $comment .= $info."\n"; | |||
There was a problem hiding this comment.
If we want a smaller fix applied only to the $info part, it would be:
$comment .= ' * '.str_replace("\n", "\n * ", $info)."\n";|
Could we edit existing fixtures to cover this (like |
|
Thanks @alexandre-daubois, I hadn't found where to test. |
alexandre-daubois
approved these changes
May 13, 2025
fabpot
approved these changes
May 14, 2025
|
Thank you @GromNaN. |
This was referenced May 25, 2025
Merged
Merged
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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-generatoruses almost the same transformation: https://github.com/nette/php-generator/blob/42806049a7774a2bd316c958f5dcf01c6b5c56fa/src/PhpGenerator/Helpers.php#L60