Updated single command How to #6876
Conversation
|
This PR will fix #6729 |
mickaelandrieu
force-pushed
the
patch-2
branch
from
60358e4 to
560426f
Compare
|
@lyrixx would you mind to review it ? You're the best as it's your feature, thank you. |
| $output->writeln($input->getOption('bar')); | ||
| }) | ||
| ->getApplication() | ||
| ->setDefaultCommand('echo', true) |
There was a problem hiding this comment.
I would highlight this line ; because this line is doing all the job. (especially the true parameter)
There was a problem hiding this comment.
You're right. How about adding a comment like:
setDefaultCommand function now accepts a second argument. If true, the application
is considerated as a Single command application.
ping @wouterj as my english is just so bad :)
There was a problem hiding this comment.
You could also add an inline comment like:
->setDefaultCommand('echo', true) // This line is responsible for
// a single command application
👍 But I'm not good with the documentation ;) Anyway, thanks for the doc. |
| (new Application('echo', '1.0.0')) | ||
| ->register('echo') | ||
| ->addArgument('foo', InputArgument::OPTIONAL, 'The directory', 'foo') | ||
| ->addOption('bar', null, InputOption::VALUE_REQUIRED, 'Foobar', 'bar') |
There was a problem hiding this comment.
What about "Foobar" => "A foobar option" to explicit the description purpose?
mickaelandrieu
force-pushed
the
patch-2
branch
2 times, most recently
from
3e042a0 to
a78ff44
Compare
|
|
||
| $application = new MyApplication(); | ||
| $application->run(); | ||
| it is possible to remove this need declaring a single command application:: |
There was a problem hiding this comment.
Even if correct, I would let the by in ...this need by declaring a single..., it's clearer imho
There was a problem hiding this comment.
it's clearer for me too, but is it correct english ?
There was a problem hiding this comment.
I go for it then :) thanks !
mickaelandrieu
force-pushed
the
patch-2
branch
3 times, most recently
from
49e3edd to
b6d06fa
Compare
|
|
mickaelandrieu
force-pushed
the
patch-2
branch
from
b6d06fa to
5535c88
Compare
|
Status: reviewed 👍 |
|
|
||
| Of course, you can still register a command as usual:: | ||
|
|
||
| #!/usr/bin/env php |
There was a problem hiding this comment.
we usually use four spaces to indent code blocks
There was a problem hiding this comment.
Ok, I will update it :)
| ->run(); | ||
|
|
||
| The method :method:`Symfony\\Component\\Console\\Application::setDefaultCommand` | ||
| accepts a boolean as second parameter. If true, the command ``echo`` will then |
There was a problem hiding this comment.
Should we elaborate a bit on this second argument? I guess that it may sound strange that you have to pass this option at all (one might expect from the name of the setDefaultCommand() method that this always is the case anyway).
There was a problem hiding this comment.
👍 for explaining what is different when passing it
There was a problem hiding this comment.
I'm not sure what you expect as an explanation, explain more is something like explain the code produced. This sounds like PHPDoc for getters/setters.
To me, in this example, the only thing to know is that passing a second parameter to setDefaultCommand transform your application into a single command application.
If someone really want to know how we do it, I'm pretty sure he/she review the code produced (as I did ^^) ... what do you think @lyrixx ? What is really relevant to understand in your contribution ?
|
I think this is great (both the docs and the simplification itself). Thanks Mickaël! |
This PR was merged into the master branch. Discussion ---------- Updated single command How to Hi, I've updated "Single command application" tutorial, regarding the recent pull request merged (symfony/symfony#16906). Mickaël Commits ------- 5535c88 Updated single command How to
Hi,
I've updated "Single command application" tutorial, regarding the recent pull request merged (symfony/symfony#16906).
Mickaël