WP_CLI::error() doesn't always terminate

[johnbillion]

The WP_CLI::error() method is marked as an early terminating method, but it doesn't terminate if the $exit parameter is set to false.

Its entry in the earlyTerminatingMethodCalls config should be removed and replaced with something else that's conditional, but I'm not sure what.

[szepeviktor]

I tell you not to use that $exit parameter.
Just like

phpstan-wordpress/README.md

Line 119 in f7ff091

- Do not enable `exit_error` in `WP_CLI::launch` or `WP_CLI::runcommand` to keep your code testable

It feels really-really bad to handle these parts of WordPress.
That is all I could contribute.

[herndlm]

a conditional return type using https://phpstan.org/writing-php-code/phpdoc-types#bottom-type in stubs might work 🤔 https://phpstan.org/r/cf63373b-41ba-4298-9639-26051d6eb5fb

[IanDelMar]

Why is WP_CLI::error() handled in szepeviktor/phpstan-wordpress and not in php-stubs/wp-cli-stubs?

[szepeviktor]

Why is WP_CLI::error() handled in szepeviktor/phpstan-wordpress and not in php-stubs/wp-cli-stubs?

Stubs are not PHPStan extensions.

[IanDelMar]

Of course, but this could be handled quite easily with a conditional return type. Simply add a file, e.g., overrides.stub:

class WP_CLI
{
  /**
   * @return ($exit is true|int<1, max> ? never : void)
   */
  public static function error($message, $exit = true)
  {
  }
}

and instruct users to add it to stubFiles in their PHPStan config file, or advise them to add the earlyTerminatingMethodCalls entry in their custom config. Just sharing ideas as the issue is still open.