Fix WPCliRuncommandDynamicReturnTypeExtension when passing invalid options

[swissspidy]

Any call like WP_CLI::runcommand('plugin list') (omitting options or omitting 'return') was wrongly typed by PHPStan as string instead of null.

As noticed in wp-cli/wp-cli#6345

Summary by CodeRabbit

• Bug Fixes
  • Improved type inference for WP_CLI::runcommand() when no return option is specified.
  • Calls that execute commands without returning output are now correctly inferred as returning null.
  • Added coverage for default behavior and calls with exit_error disabled.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: eb8abd10-0cd1-4623-9c16-666a0497a215

📥 Commits

Reviewing files that changed from the base of the PR and between 0c0b800 and 85501aa.

📒 Files selected for processing (2)

• src/PHPStan/WPCliRuncommandDynamicReturnTypeExtension.php
• tests/data/runcommand.php

---

📝 Walkthrough

Walkthrough

The dynamic return type extension now defaults an unspecified return option to false. Test cases verify that WP_CLI::runcommand() returns null for default options and when exit_error is explicitly disabled.

Changes

Runcommand return inference

Layer / File(s)	Summary
Default return inference and validation src/PHPStan/WPCliRuncommandDynamicReturnTypeExtension.php, tests/data/runcommand.php	The inferred default return option is changed to false, with assertions covering default plugin list calls and calls using exit_error => false that return null.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title mentions invalid options, but the change actually fixes the default PHPStan return type when no return option is provided.	Rename it to reflect the typing fix, e.g. "Fix WP_CLI::runcommand() return type when no return option is set".
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/runcommand-hardening

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 PHPStan (2.2.5)

PHPStan was skipped because the config uses disallowed bootstrapFiles, bootstrapFile, or includes directives.

---

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...Stan/WPCliRuncommandDynamicReturnTypeExtension.php	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!