Context Navigation

← Previous Changeset
Next Changeset →

Changeset 62292

Timestamp:

05/02/2026 05:16:01 AM (2 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.

Location:

trunk

Files:

: 1 added
: 3 edited

composer.json (modified) (1 diff)
tests/phpstan/GlobalDocBlockVisitor.php (added)
tests/phpstan/base.neon (modified) (2 diffs)
tests/phpstan/bootstrap.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

trunk/composer.json

-              r62271
+              r62292
                 "lock": false
         },
+        "autoload-dev": {
+                "psr-4": {
+                        "WordPress\\PHPStan\\": "tests/phpstan/"
+                }
+        },
         "scripts": {
                 "phpstan": "@php ./vendor/bin/phpstan analyse --memory-limit=2G",

trunk/tests/phpstan/base.neon

-              r61873
+              r62292
+#
 # 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:
 …
                 - ../../src/wp-trackback.php
                 - ../../src/xmlrpc.php
+                - GlobalDocBlockVisitor.php
         bootstrapFiles:
                 - bootstrap.php

trunk/tests/phpstan/bootstrap.php

-              r61699
+              r62292
 <?php
 /**
  * Defines default WordPress constants for discovery.
+ * Defines default WordPress constants for PHPStan discovery.
+ *
  * Mocks the constant initiation that would normally happen in wp-includes/wp-settings.php.
+ *
+ * Loaded as a `bootstrapFile` by PHPStan; see `base.neon`.
  */

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core