support multiline comments in add flow

Author: shmax

src/Printer/Printer.php

@@ -601,7 +601,7 @@ private function printArrayFormatPreserving(array $nodes, array $originalNodes,
 					$result .= $insertStr;
 					if (count($comments) > 0) {
 						$result .= sprintf('%s%s*%s', $originalTokens->getDetectedNewline() ?? "\n", $beforeAsteriskIndent, $afterAsteriskIndent);
-						$result .= $this->pComments($comments);
+						$result .= $this->pComments($comments, $beforeAsteriskIndent, $afterAsteriskIndent);
 					}
 					$result .= sprintf('%s%s*%s', $originalTokens->getDetectedNewline() ?? "\n", $beforeAsteriskIndent, $afterAsteriskIndent);
 				} else {
@@ -688,12 +688,12 @@ private function printArrayFormatPreserving(array $nodes, array $originalNodes,
 	/**
 	 * @param array<Comment> $comments
 	 */
-	protected function pComments(array $comments): string
+	protected function pComments(array $comments, string $beforeAsteriskIndent, string $afterAsteriskIndent): string
 	{
 		$formattedComments = [];
 
 		foreach ($comments as $comment) {
-			$formattedComments[] = $comment->getReformattedText() ?? '';
+			$formattedComments[] = str_replace("\n", "\n".$beforeAsteriskIndent."*".$afterAsteriskIndent, $comment->getReformattedText() ?? '');
 		}
 
 		return implode("\n", $formattedComments);

tests/PHPStan/Printer/PrinterTest.php

@@ -664,17 +664,33 @@ public function enterNode(Node $node)
 
 		};
 
-		$addItemsToMultilineArrayShape = new class extends AbstractNodeVisitor {
+		$addSingleLineCommentsToMultilineArrayShape = new class extends AbstractNodeVisitor {
 
 			public function enterNode(Node $node)
 			{
 				if ($node instanceof ArrayShapeNode) {
-					$commentedNode = new ArrayShapeItemNode(new IdentifierTypeNode('c'), false, new IdentifierTypeNode('int'));
+					$commentedNode = new ArrayShapeItemNode(new IdentifierTypeNode('b'), false, new IdentifierTypeNode('int'));
 					$commentedNode->setAttribute(Attribute::COMMENTS, [new Comment('// bar')]);
 					array_splice($node->items, 1, 0, [
 						$commentedNode,
 					]);
-					$node->items[] = new ArrayShapeItemNode(new IdentifierTypeNode('d'), false, new IdentifierTypeNode('string'));
+					$commentedNode = new ArrayShapeItemNode(new IdentifierTypeNode('d'), false, new IdentifierTypeNode('string'));
+					$commentedNode->setAttribute(Attribute::COMMENTS, [new Comment(
+'/* This is a
+   multiline
+   comment
+ */'
+					)]);
+					$node->items[] = $commentedNode;
+
+					$commentedNode = new ArrayShapeItemNode(new IdentifierTypeNode('e'), false, new IdentifierTypeNode('string'));
+					$commentedNode->setAttribute(Attribute::COMMENTS, [new Comment(
+						'/* Another
+ * multiline
+ * comment with leading asterisks
+ */'
+					)]);
+					$node->items[] = $commentedNode;
 				}
 
 				return $node;
@@ -687,22 +703,32 @@ public function enterNode(Node $node)
  * @return array{
  *  // foo
  *	a: int,
- *	b: string
+ *	c: string
  * }
  */',
 			'/**
  * @return array{
  *  // foo
  *	a: int,
  *  // bar
- *  c: int,
- *	b: string,
- *  d: string
+ *  b: int,
+ *	c: string,
+ *  /* This is a
+ *     multiline
+ *     comment
+ *   */
+ *  d: string,
+ *  /* Another
+ *   * multiline
+ *   * comment with leading asterisks
+ *   */
+ *  e: string
  * }
  */',
-			$addItemsToMultilineArrayShape,
+			$addSingleLineCommentsToMultilineArrayShape,
 		];
 
+
 		yield [
 			'/**
  * @return array{float}