Changeset 62292 for trunk/tests/phpstan/base.neon

Timestamp:

05/02/2026 05:16:01 AM (4 months ago)

Author:

westonruter

Message:

Build/Test Tools: Honor @global docblock tags in PHPStan analysis.

This adds a PHPStan extension with a parser-node visitor that bridges WordPress core's @global Type $varname PHPDoc convention to PHPStan's variable type resolution, eliminating 3,784 spurious errors caused by globals resolving as mixed when on rule level 10 (out of 40,069 errors total, so a 9.4% reduction). This avoids the need to add /** @var Type $varname */ annotations with each global variable.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11692

Props westonruter, apermo, szepeviktor.
See #64898.

File:

• trunk/tests/phpstan/base.neon (modified) (2 diffs)

trunk/tests/phpstan/base.neon

@@ -4 +4 @@
 #
 # https://phpstan.org/config-reference
+
+services:
+        # Bridges WordPress core's `@global Type $varname` function docblock convention to
+        # PHPStan's variable type resolution. See tests/phpstan/GlobalDocBlockVisitor.php.
+        -
+                class: WordPress\PHPStan\GlobalDocBlockVisitor
+                tags:
+                        - phpstan.parser.richParserNodeVisitor
 
 parameters:
@@ -91 +99 @@
                 - ../../src/wp-trackback.php
                 - ../../src/xmlrpc.php
+                - GlobalDocBlockVisitor.php
         bootstrapFiles:
                 - bootstrap.php