feat: report invalid @param tags

Author: williamdes

src/Parser/NodeVisitor.php

@@ -451,6 +451,22 @@ private function findParameterInTags(array $tags, string $tagName): ?array
         return null;
     }
 
+    /**
+     * @param array[] $tags All the tags
+     *
+     * @return string[] The invalid tags
+     */
+    private function getInvalidTags(array $tags): array
+    {
+        $invalidTags = [];
+        foreach ($tags as $tag) {
+            if (! is_array($tag)) {
+                $invalidTags[] = $tag;
+            }
+        }
+        return $invalidTags;
+    }
+
     /**
      * @param FunctionReflection|MethodReflection $method
      * @param array[] $tags
@@ -496,6 +512,21 @@ protected function updateMethodParametersFromTags(Reflection $method, array $tag
             );
         }
 
+        $invalidTags = $this->getInvalidTags($tags);
+        if (count($invalidTags) > 0) {
+            $errors[] = sprintf(
+                'The method "%s" has "%d" invalid @param tags.',
+                $method->getName(),
+                count($invalidTags)
+            );
+            foreach ($invalidTags as $invalidTag) {
+                $errors[] = sprintf(
+                    'Invalid @param tag on "%s": "%s"',
+                    $method->getName(),
+                    $invalidTag
+                );
+            }
+        }
         return $errors;
     }
 

tests/Parser/NodeVisitorTest.php

@@ -397,6 +397,39 @@ public function testUpdateMethodParametersFromInvalidTags(): void
             [
                 'The "param2" parameter of the method "fun1" is missing a @param tag',
                 'The method "fun1" has "6" @param tags but only "2" where expected.',
+                'The method "fun1" has "1" invalid @param tags.',
+                'Invalid @param tag on "fun1": "array[\Illuminate\Notifications\Channels\Notification]  $notification"',
+            ],
+            $this->callMethod($visitor, 'updateMethodParametersFromTags', [
+                $function,
+                $docBlockNode->getTag('param')
+            ])
+        );
+    }
+
+    /**
+     * @see NodeVisitor::updateMethodParametersFromTags
+     */
+    public function testUpdateMethodParametersFromInvalidTagsReport(): void
+    {
+        $docBlockParser = new DocBlockParser();
+        $docBlockNode = $docBlockParser->parse(
+            '/**' . "\n"
+            . '* @param array[\Illuminate\Notifications\Channels\Notification]  $notification' . "\n"
+            . '**/' . "\n"
+        );
+        $parserContext = new ParserContext(new TrueFilter(), new DocBlockParser(), new Standard());
+        $visitor = new NodeVisitor($parserContext);
+        $function = new FunctionReflection('fun1', 0);
+
+        $param1 = (new ParameterReflection('notification', 0));
+        $function->addParameter($param1);
+
+        $this->assertSame(
+            [
+                'The "notification" parameter of the method "fun1" is missing a @param tag',
+                'The method "fun1" has "1" invalid @param tags.',
+                'Invalid @param tag on "fun1": "array[\Illuminate\Notifications\Channels\Notification]  $notification"',
             ],
             $this->callMethod($visitor, 'updateMethodParametersFromTags', [
                 $function,