Using the MyCommand example in the documentation

use Zenstruck\Console\CommandRunner;
class AppController extends AbstractController
{

    #[Route(path: '/run-command', name: 'app_run_command')]
    public function runCommand(MyCommand $command): Response
    {
        CommandRunner::for($command, 'Bob p@ssw0rd --role ROLE_ADMIN')->run(); // works great
        CommandRunner::for($command, '--help')->run(); // fails, says --help isn't defined
    }
}

I'd like to autowire an invokable command from within a bundle. While I simply auto-wire it, I get this error:

  Cannot autowire service "Survos\Bundle\MakerBundle\Command\MakeMethodCommand": argument "$container" of method "Zenstruck\Console\InvokableServiceCommand::setInvokeContainer()" references interface "Psr\Container  
  \ContainerInterface" but no such service exists. Available autowiring aliases for this interface are: "$parameterBag".                                                       

So I added a method call to the container (guessing, really)

        $builder->autowire(MyCommand::class)
            ->addTag('console.command')
            ->addMethodCall('setInvokeContainer', [new Reference('service_container')])
        ;

And now get:

In Container.php line 235:
                                                                                                                                                                                                                        
  The "Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface" service or alias has been removed or inlined when the container was compiled. You should either make it public, or stop using the con  
  tainer directly and use dependency injection instead.                                                                                                                                                                 
          

What is the correct way to autowire the command? Does it need to happen in the compilerPass?

bin/console my:command --help 
bin/console make:crud --help 

Symfony's make:crud shows some help lines at the bottom, how is that set in an invokable command? I tried adding this to __invoke, but it didn't seem to work (although again, it might be related to lazy-loading).

        $this
            // the command help shown when running the command with the "--help" option
            ->setHelp('This is the help, not the description, and can be multiple lines.');

Using the MyCommand example in the documentation

use Zenstruck\Console\CommandRunner;
class AppController extends AbstractController
{

    #[Route(path: '/run-command', name: 'app_run_command')]
    public function runCommand(MyCommand $command): Response
    {
        CommandRunner::for($command, 'Bob p@ssw0rd --role ROLE_ADMIN')->run(); // works great
        CommandRunner::for($command, '--help')->run(); // fails, says --help isn't defined
    }
}

public function __invoke(
    #[Argument(...see InputArgument constructor...)]
    string $arg1,

    #[Option(...see InputOption constructor...)]
    string $opt1,
)

class MyCommand extends \Symfony\Component\Console\Command\Command
{
    use Invokable;

    // $username/$roles are the argument/option defined below
    public function __invoke(IO $io, string $username, array $roles)
    {
        $io->success('created.');

        // even if you don't inject IO, it's available as a method:
        $this->io(); // IO
    }

    public function configure(): void
    {
        $this
            ->addArgument('username', InputArgument::REQUIRED)
            ->addOption('roles', mode: InputOption::VALUE_IS_ARRAY)
        ;
    }
}

final class CreateUserCommand extends InvokableServiceCommand
{
    public function __invoke(IO $io): void
    {
        $env = $this->parameter('kernel.environment');
    }
}

class MyCommand extends Command
{
    use Invokable, ExecutesProcess;

    public function __invoke(IO $io)
    {
        $this->executeProcess('/some/script');

        // hide sensitive strings (replaces with XXX)
        $this->executeProcess('/some/script', ['my-database-password']);
    }
}

class MyCommand extends Command
{
    use Invokable, ExecutesCommands;

    public function __invoke(IO $io)
    {
        $this->executeCommand('doctrine:database:drop', ['--force' => true]);

        // equivalent to above
        $this->executeCommand('doctrine:database:drop --force');
    }
}

Added via event or base command constructor.

Use Case:

Would give the ability to change the IO style w/o updating typehints.

$command->useArgumentFactory(IO::class, fn($input, $output) => new CustomIO($input, $output));

Add Argument/Option attributes:

#[Argument('arg1', Argument::REQUIRED, 'some description', 'default')]
#[Option('option1', 'o', Option::VALUE_Required, 'some description', 'default')]
class MyCommand extends Command {}

Unlike other services, injecting a stateMachine during invoke throws an exception:

    public function __invoke(
        IO                     $io,
        WorkflowInterface  $catalogStateMachine

In CheckExceptionOnInvalidReferenceBehaviorPass.php line 83:
                                                                                                                                     
  The service ".service_locator.Va9WIi3" has a dependency on a non-existent service "Symfony\Component\Workflow\WorkflowInterface".  
                                                                                                                                     

I wonder if it has to do with the ability to inject a specific service by name, rather than just type. Injecting via the constructor works as expected.

    public function __construct(private WorkflowInterface  $catalogStateMachine, string $name = null)
    {
        parent::__construct($name);
    }

    public function __invoke(
        IO                     $io,

        #[Option(description: 'do not actually update')] // default name: 'dry-run' ? 
        bool    $dryRun,

It seems to me that the default name should be 'dry-run', since I don't think camelCase is used as frequently.

https://commons.apache.org/proper/commons-cli/

bin/console do:something --dryRun
bin/console do:something --dry-run

All Symfony commands:

  -n, --no-interaction  Do not ask any interactive question
  -e, --env=ENV         The Environment name. [default: "dev"]
      --no-debug        Switch off debug mode.

Of course, that's a BC change.

Can the invokable commands use validation? That is

Since you're looking at Closures for auto-completion, I wanted to brainstorm about the idea of assertions / validations in the commands.

One approach:

#[Argument(description: 'path to image directory', assert: fn(string $path) => is_dir($path), msg: "%s is not a valid path")]
string $path,

// to replace

): void {

    if (!is_dir($path)) {
        throw new \LogicException("$path is not a directory");
    }

Perhaps the assertion could also take a Symfony Expression?

It's not just individual elements that need validation, it might be the whole set (like a form validation).

#[Argument(description: 'image to process', assert: [$this, 'fileExists'])]
?string $imageFilename,

private function fileExists() {
    $pathToImage = $this->path . $this->imageFilename;
    if (!file_exists($pathToImage)) {
        throw new \LogicException("$pathToImage is not a file");
    }

Of course, even better would be to use the Symfony validators that already exist:

#[AsCommand('app:create-record', 'Create an image record with associated PDF')]
final class MyCommand extends InvokableServiceCommand
{
    use ConfigureWithAttributes, RunsCommands, RunsProcesses;

    public function __invoke(
        IO      $io,

        #[Argument(description: 'path to pdf')]
        #[Assert\File(
            mimeTypes: ['application/pdf', 'application/x-pdf'],
            mimeTypesMessage: 'Please provide a valid PDF',
        )]
        string  $pdf,

        #[Argument(description: 'image filename')]
        #[Assert\Image()]
        string  $image,

        #[Option(description: 'path to pdf')]
        #[Assert\File()]
        ?string $pdfPath="~/Documents/",

The Constraint would need to be extended, to allow for the property: \Attribute::TARGET_PARAMETER

#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE | \Attribute::TARGET_PARAMETER)]
class File extends Constraint

Again, just brainstorming. It feels like there's an elegant solution in here somewhere.

Is there a way to add suggested values (as an array or closure) to invokable commands? From the Symfony console documentation at https://symfony.com/doc/current/console/input.html#adding-argument-option-value-completion

// ...
use Symfony\Component\Console\Completion\CompletionInput;
use Symfony\Component\Console\Completion\CompletionSuggestions;

class GreetCommand extends Command
{
    // ...
    protected function configure(): void
    {
        $this
            ->addArgument(
                'names',
                InputArgument::IS_ARRAY,
                'Who do you want to greet (separate multiple names with a space)?',
                null,
                function (CompletionInput $input) {
                    // the value the user already typed, e.g. when typing "app:greet Fa" before
                    // pressing Tab, this will contain "Fa"
                    $currentValue = $input->getCompletionValue();

                    // get the list of username names from somewhere (e.g. the database)
                    // you may use $currentValue to filter down the names
                    $availableUsernames = ...;

                    // then suggested the usernames as values
                    return $availableUsernames;
                }
            )
        ;
    }
}

Is there a way to enhance the configuration? Maybe something like

$argument = $this->getArgument('names');
$argument->setSuggestedValues(function (...));

Obviously, I'm trying to see if it's possible to switch completely to invokable commands.

bin/console my:command --help 
bin/console make:crud --help 

Symfony's make:crud shows some help lines at the bottom, how is that set in an invokable command? I tried adding this to __invoke, but it didn't seem to work (although again, it might be related to lazy-loading).

        $this
            // the command help shown when running the command with the "--help" option
            ->setHelp('This is the help, not the description, and can be multiple lines.');