Add initial PHPStan config by swissspidy · Pull Request #154 · wp-cli/restful

swissspidy · 2026-04-02T10:59:26Z

No description provided.

codecov · 2026-04-02T11:00:56Z

Codecov Report

❌ Patch coverage is 40.29851% with 120 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
inc/RestCommand.php	38.66%	92 Missing ⚠️
inc/Runner.php	45.09%	28 Missing ⚠️

📢 Thoughts on this report? Let us know!

gemini-code-assist

Code Review

This pull request introduces a PHPStan configuration and adds comprehensive PHPDoc type hints to improve static analysis. Key changes include refactoring the diff_items logic to be more explicit, replacing manual WP_INSTALLING constant checks with the wp_installing() function, and correcting the casing of the RestCommand class instantiation. A regression was identified in inc/RestCommand.php where removing the reference operator from the $assoc_args parameter in get_formatter prevents the Formatter from correctly modifying the arguments array as expected by WP-CLI.

gemini-code-assist · 2026-04-02T11:01:25Z

inc/RestCommand.php

 	 * @return \WP_CLI\Formatter
 	 */
-	protected function get_formatter( &$assoc_args ) {
+	protected function get_formatter( $assoc_args ) {


The $assoc_args parameter should be passed by reference. In WP-CLI, the Formatter class constructor expects a reference to the associative arguments array and may modify it (e.g., to remove formatting-specific flags so they aren't processed as data fields). By removing the reference here, get_formatter passes a local copy to the Formatter, which breaks the expected behavior where the Formatter can update the caller's arguments array.

protected function get_formatter( &$assoc_args ) {

Copilot

Pull request overview

Adds an initial PHPStan configuration for the package and updates REST CLI runtime code with additional type checks/guards to satisfy higher static-analysis strictness.

Changes:

Add phpstan.neon.dist with level 9 analysis targeting inc/ and wp-rest-cli.php, scanning WP-CLI sources and WordPress stubs.
Harden Runner route discovery/registration with additional validation and updated debug/error messaging.
Add/adjust phpdoc types and runtime guards in RestCommand for safer handling of decoded JSON, CLI args, and REST responses.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
phpstan.neon.dist	Introduces baseline PHPStan configuration for the project.
inc/Runner.php	Adds stricter validation/typing around REST index parsing and route registration.
inc/RestCommand.php	Adds extensive type guards and phpdoc to reduce PHPStan findings and avoid notices.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-07T10:38:56Z

inc/Runner.php

-			$name         = $route_data['schema']['title'];
-			$rest_command = new RESTCommand( $name, $route, $route_data['schema'] );
+			if ( empty( $route_data['schema']['title'] ) || ! is_string( $route_data['schema']['title'] ) ) {
+				WP_CLI::debug( "No valid schema title found for {$route}, skipping REST command registration.", 'rest' );


The debug message text changed from "No schema title found" to "No valid schema title found". This string is referenced in existing Behat coverage (features/load-rest.feature) and changing it will break that expectation and any tooling that greps debug logs; consider keeping the original wording (and still validate the type) or updating tests in the same PR.

Suggested change

WP_CLI::debug( "No valid schema title found for {$route}, skipping REST command registration.", 'rest' );

WP_CLI::debug( "No schema title found for {$route}, skipping REST command registration.", 'rest' );

Copilot · 2026-04-07T10:38:57Z

inc/Runner.php

 		}
-		return json_decode( $response->body, true );
+		$index = json_decode( $response->body, true );
+		/** @var array<string, mixed>|false $index */


get_api_index() declares it returns array<string, mixed>|false, but json_decode() can also return null/scalar for invalid/unexpected JSON. Consider normalizing the decoded value (e.g., return false unless it’s an array) or widening the @return type so callers/static analysis aren’t misled.

Suggested change

/** @var array<string, mixed>|false $index */

if ( ! is_array( $index ) ) {

return false;

}

Copilot · 2026-04-07T10:38:57Z

inc/RestCommand.php

+		$count = 0;
+		if ( isset( $assoc_args['count'] ) ) {
+			$count = is_numeric( $assoc_args['count'] ) ? (int) $assoc_args['count'] : 0;
+		}
 		unset( $assoc_args['count'] );
-		$format = $assoc_args['format'];
+
+		$format = 'ids';
+		if ( isset( $assoc_args['format'] ) ) {
+			$format = is_scalar( $assoc_args['format'] ) ? (string) $assoc_args['format'] : 'ids';
+		}
 		unset( $assoc_args['format'] );


generate_items() falls back to count=0 and format='ids' when assoc args are missing, but the command synopsis in Runner::register_route_commands() documents defaults of count=10 and format='progress'. Align these defaults (or explicitly rely on WP-CLI to inject synopsis defaults) to avoid surprising behavior when options aren’t provided.

Copilot · 2026-04-07T10:38:57Z

inc/RestCommand.php

+		$php_bin     = WP_CLI::get_php_binary();
+		$argv        = isset( $GLOBALS['argv'] ) && is_array( $GLOBALS['argv'] ) ? $GLOBALS['argv'] : array();
+		$script_path = '';
+		if ( isset( $argv[0] ) && is_string( $argv[0] ) ) {
+			$script_path = $argv[0];
+		}


If $GLOBALS['argv'][0] is missing or non-string, $script_path becomes an empty string and the spawned command will end up treating the next token as the script file (breaking diff). It would be safer to hard-fail with a clear error when the script path can’t be determined instead of attempting to run with an empty script.

Suggested change

$php_bin = WP_CLI::get_php_binary();

$argv = isset( $GLOBALS['argv'] ) && is_array( $GLOBALS['argv'] ) ? $GLOBALS['argv'] : array();

$script_path = '';

if ( isset( $argv[0] ) && is_string( $argv[0] ) ) {

$script_path = $argv[0];

}

$php_bin = WP_CLI::get_php_binary();

$argv = isset( $GLOBALS['argv'] ) && is_array( $GLOBALS['argv'] ) ? $GLOBALS['argv'] : array();

if ( ! isset( $argv[0] ) || ! is_string( $argv[0] ) || '' === $argv[0] ) {

WP_CLI::error( 'Unable to determine the current WP-CLI script path for spawning the diff command.' );

}

$script_path = $argv[0];

Copilot · 2026-04-07T10:38:58Z

inc/RestCommand.php

 				}
 			}
+			assert( is_int( $response->status_code ) );
 			return array( $response->status_code, json_decode( $response->body, true ), $response->headers->getAll() );


In the HTTP branch, the response body is json_decoded into $body (and normalized to an array) but the return statement json_decodes again and returns that second result. This both double-parses JSON and discards the normalized $body; consider returning the already-decoded $body to avoid extra work and keep behavior consistent.

Suggested change

return array( $response->status_code, json_decode( $response->body, true ), $response->headers->getAll() );

return array( $response->status_code, $body, $response->headers->getAll() );

swissspidy added 5 commits March 31, 2026 23:03

Add initial PHPStan config

0aedd07

Level 2

5819f4b

Level 4

05892c4

Level 5

16fd934

Level 6

a690e15

This comment was marked as resolved.

Sign in to view

github-actions bot added the scope:testing label Apr 2, 2026

gemini-code-assist bot reviewed Apr 2, 2026

View reviewed changes

swissspidy added 5 commits April 2, 2026 13:07

Lint fix

1a2ea93

Level 7

91c995e

Level 8

d1918f5

Level 9

e3804eb

Lint fix

5c9419f

swissspidy marked this pull request as ready for review April 7, 2026 10:32

swissspidy requested a review from a team as a code owner April 7, 2026 10:32

Copilot AI review requested due to automatic review settings April 7, 2026 10:32

Copilot started reviewing on behalf of swissspidy April 7, 2026 10:33 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial PHPStan config#154

Add initial PHPStan config#154
swissspidy wants to merge 10 commits intomainfrom
fix/phpstan

swissspidy commented Apr 2, 2026

Uh oh!

This comment was marked as resolved.

codecov bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Apr 2, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Copilot AI Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	WP_CLI::debug( "No valid schema title found for {$route}, skipping REST command registration.", 'rest' );
	WP_CLI::debug( "No schema title found for {$route}, skipping REST command registration.", 'rest' );

-		/** @var array<string, mixed>|false $index */
+		if ( ! is_array( $index ) ) {
+			return false;
+		}

	return array( $response->status_code, json_decode( $response->body, true ), $response->headers->getAll() );
	return array( $response->status_code, $body, $response->headers->getAll() );

Conversation

swissspidy commented Apr 2, 2026

Uh oh!

This comment was marked as resolved.

codecov bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Apr 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Apr 2, 2026 •

edited

Loading