[Console] Add support for invokable commands and input attributes

[chalasr]

Q	A
Feature PR	symfony/symfony#59340
PR author(s)	@yceruto
Merged in	7.3

We created this issue to not forget to document this new feature. We would really appreciate if you can help us with this task. If you are not sure how to do it, please ask us and we will help you.

To fix this issue, please create a PR against the 7.3 branch in the symfony-docs repository.

Thank you! 😃

[chalasr]

needs to be taken into account when tackling this:

• [Console] Invokable command deprecations symfony#59474

[chalasr]

Also

• [Console] Invokable command adjustments symfony#59493
• [Console] Add broader support for command "help" definition symfony#59473

[yceruto]

Also symfony/symfony#59565

[tacman]

Until the documentation is written, is there an example of a trivial command using input attributes? Thx.

[chalasr]

@tacman You can find one in the code PR: symfony/symfony#59340

[tacman]

Here's a working example:

symfony new --version=next --webapp test-console7.3 && cd test-console7.3 
bin/console make:command lucky:number  

cat > src/Command/LuckyNumberCommand.php <<'END'
<?php

namespace App\Command;

use Symfony\Component\Console\Attribute\Argument;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Attribute\Option;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Style\SymfonyStyle;

#[AsCommand(name: 'lucky:number')]
class LuckyNumberCommand extends Command
{
    public function __construct(
    )
    {
        parent::__construct();
    }

    public function __invoke(SymfonyStyle $io,
                             #[Argument] string $name,
                             #[Option] bool $formal=true): void
    {
        $io->title(sprintf('%s %s!', $formal ? 'Hello' : 'Hey', ucfirst($name)));
        $io->success(sprintf('Today\'s Lucky Number: %d', rand(0, 400)));
    }
}
END
bin/console lucky:number bob

[yceruto]

I've started looking into this and have a question: should we replace the old signature everywhere or just add a new section for the new one?

[OskarStark]

I would just add a new one

[alamirault]

I think the new attribute approach will be the new standard right ?
(readonly and final classes, no inheritance, same DX than for controllers)

Newcomers to symfony shouldn't see it first ? (to see how powerfull is it)

[yceruto]

I’d go with @alamirault’s view on this, but let’s wait a bit to hear other opinions.

[OskarStark]

It is not feature complete now compared to the old way, so I would still propose the old version first.

@chalasr what do you think?