Merge pull request #9383 from weirdan/process-psalm-api-on-methods

vimeo · Feb 23, 2023 · e96a929 · e96a929
2 parents d0a1400 + 2e90cb6
commit e96a929
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 0 deletions.
diff --git a/src/Psalm/Internal/Codebase/ClassLikes.php b/src/Psalm/Internal/Codebase/ClassLikes.php
@@ -1703,6 +1703,10 @@ private function checkMethodReferences(ClassLikeStorage $classlike_storage, Meth
                 continue;
             }
 
+            if ($method_storage->public_api) {
+                continue;
+            }
+
             if ($method_storage->location
                 && !$project_analyzer->canReportIssues($method_storage->location->file_path)
                 && !$codebase->analyzer->canReportIssues($method_storage->location->file_path)

diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockParser.php b/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockParser.php
@@ -555,6 +555,8 @@ public static function parse(
             $info->description = $parsed_docblock->description;
         }
 
+        $info->public_api = isset($parsed_docblock->tags['psalm-api']) || isset($parsed_docblock->tags['api']);
+
         return $info;
     }
 

diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php b/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php
@@ -417,6 +417,8 @@ public static function addDocblockInfo(
         if ($docblock_info->description) {
             $storage->description = $docblock_info->description;
         }
+
+        $storage->public_api = $docblock_info->public_api;
     }
 
     /**

diff --git a/src/Psalm/Internal/Scanner/FunctionDocblockComment.php b/src/Psalm/Internal/Scanner/FunctionDocblockComment.php
@@ -174,4 +174,6 @@ class FunctionDocblockComment
 
     /** @var array<string, array{lines:list<int>, suggested_replacement?:string}> */
     public array $unexpected_tags = [];
+
+    public bool $public_api = false;
 }
diff --git a/src/Psalm/Storage/FunctionLikeStorage.php b/src/Psalm/Storage/FunctionLikeStorage.php
@@ -243,6 +243,8 @@ abstract class FunctionLikeStorage implements HasAttributesInterface
      */
     public $description;
 
+    public bool $public_api = false;
+
     public function __toString(): string
     {
         return $this->getSignature(false);

diff --git a/tests/UnusedCodeTest.php b/tests/UnusedCodeTest.php
@@ -1263,6 +1263,16 @@ protected function c(): void {}
                     }
                     PHP,
             ],
+            'psalm-api on unused public method' => [
+                'code' => <<<'PHP'
+                    <?php
+                    class A {
+                        /** @psalm-api */
+                        public function b(): void {}
+                    }
+                    new A;
+                    PHP,
+            ],
         ];
     }