Fix #1799 - support trailing commas in object-like docblock types

vimeo · Jun 18, 2019 · b12f051 · b12f051
1 parent 1bdd444
commit b12f051
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 2 deletions.
diff --git a/src/Psalm/Internal/Analyzer/CommentAnalyzer.php b/src/Psalm/Internal/Analyzer/CommentAnalyzer.php
@@ -76,7 +76,9 @@ public static function getTypeFromComment(
                     $type_start = $offset + $comment->getFilePos();
                     $type_end = $type_start + strlen($line_parts[0]);
 
-                    $line_parts[0] = str_replace("\n", '', preg_replace('@^[ \t]*\*@m', '', $line_parts[0]));
+                    $line_parts[0] = preg_replace('@^[ \t]*\*@m', '', $line_parts[0]);
+                    $line_parts[0] = preg_replace('/,\n\s+\}/', '}', $line_parts[0]);
+                    $line_parts[0] = str_replace("\n", '', $line_parts[0]);
 
                     if ($line_parts[0] === ''
                         || ($line_parts[0][0] === '$'
@@ -308,7 +310,9 @@ public static function extractFunctionDocblockInfo(PhpParser\Comment\Doc $commen
                         $start = $offset + $comment->getFilePos();
                         $end = $start + strlen($line_parts[0]);
 
-                        $line_parts[0] = str_replace("\n", '', preg_replace('@^[ \t]*\*@m', '', $line_parts[0]));
+                        $line_parts[0] = preg_replace('@^[ \t]*\*@m', '', $line_parts[0]);
+                        $line_parts[0] = preg_replace('/,\n\s+\}/', '}', $line_parts[0]);
+                        $line_parts[0] = str_replace("\n", '', $line_parts[0]);
 
                         if ($line_parts[0] === ''
                             || ($line_parts[0][0] === '$'

diff --git a/tests/AnnotationTest.php b/tests/AnnotationTest.php
@@ -1014,6 +1014,30 @@ function f(A $a) : void {
                         $a->bar();
                     }'
             ],
+            'allowClosingComma' => [
+                '<?php
+                    /**
+                     * @param array{
+                     *    foo: string,
+                     *    bar: string,
+                     *    baz: array{
+                     *       a: int,
+                     *    },
+                     * } $foo
+                     */
+                    function foo(array $foo) : int {
+                      return count($foo);
+                    }
+
+                    /**
+                     * @var array{
+                     *    foo:string,
+                     *    bar:string,
+                     *    baz:string,
+                     * } $foo
+                     */
+                    $foo = ["foo" => "", "bar" => "", "baz" => ""];'
+            ],
         ];
     }