Add --use-include flag in order to overcome eval() limitations

[mklepaczewski]

Feature Request

• [x] Yes, I reviewed the contribution guidelines.

Describe your use case and the problem you are facing

eval-file uses eval() to execute code in provided script. Unfortunately, this has some limitations:

• declare(strict_types=1) in the script file throws a fatal error in eval()
• evale'd code cannot be debugged using XDebug.

Describe the solution you'd like

I propose to add --use-require flag to eval-file to indicate that the script should be executed using require().

If the proposal is accepted I'm willing to implement it.

[danielbachhuber]

Thanks for the request, @mklepaczewski !

I propose to add --use-require flag to eval-file to indicate that the script should be executed using require().

Given the limitations you've described, your proposal seems reasonable.

Here's where wp eval-file switched from include( $file ) to eval(): https://github.com/wp-cli/eval-command/pull/21

Let's restore include( $file ) as an option, instead of using require().

[kozer]

@danielbachhuber I'll start working on it! Can you assign it to me, please? Thanks!

[kozer]

@danielbachhuber I have a question on this issue:

The eval command handles two scenarios:

• It can read a file given its path.
• It can read directly from STDIN.

include takes a file path as an input, so the --use-require makes sense in the first case. How we should handle the STDIN?

Let's say for example something like:

cat script.php | wp eval-file - x y z --skip-wordpress --use-require

[danielbachhuber]

include takes a file path as an input, so the --use-require makes sense in the first case. How we should handle the STDIN?

@kozer If the user provides wp eval-file --use-include -, then the command should call WP_CLI::error() and explain that both arguments can't be used at the same time.