Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[RFC][Console] Added console style guide helpers (v2)
- Loading branch information
Showing
6 changed files
with
747 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Console\Helper; | ||
|
|
||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Question\ChoiceQuestion; | ||
| use Symfony\Component\Console\Question\ConfirmationQuestion; | ||
| use Symfony\Component\Console\Question\Question; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
|
|
||
| /** | ||
| * Symfony Style Guide compliant question helper. | ||
| * | ||
| * @author Kevin Bond <kevinbond@gmail.com> | ||
| */ | ||
| class SymfonyQuestionHelper extends QuestionHelper | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function ask(InputInterface $input, OutputInterface $output, Question $question) | ||
| { | ||
| $validator = $question->getValidator(); | ||
| $question->setValidator(function ($value) use ($validator) { | ||
| if (null !== $validator && is_callable($validator)) { | ||
| $value = $validator($value); | ||
| } | ||
|
|
||
| // make required | ||
| if (!is_array($value) && !is_bool($value) && 0 === strlen($value)) { | ||
| throw new \Exception('A value is required.'); | ||
| } | ||
|
|
||
| return $value; | ||
| }); | ||
|
|
||
| return parent::ask($input, $output, $question); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function writePrompt(OutputInterface $output, Question $question) | ||
| { | ||
| $text = $question->getQuestion(); | ||
| $default = $question->getDefault(); | ||
|
|
||
| switch (true) { | ||
| case null === $default: | ||
| $text = sprintf(' <info>%s</info>:', $text); | ||
|
|
||
| break; | ||
|
|
||
| case $question instanceof ConfirmationQuestion: | ||
| $text = sprintf(' <info>%s (yes/no)</info> [<comment>%s</comment>]:', $text, $default ? 'yes' : 'no'); | ||
|
|
||
| break; | ||
|
|
||
| case $question instanceof ChoiceQuestion: | ||
| $choices = $question->getChoices(); | ||
| $text = sprintf(' <info>%s</info> [<comment>%s</comment>]:', $text, $choices[$default]); | ||
|
|
||
| break; | ||
|
|
||
| default: | ||
| $text = sprintf(' <info>%s</info> [<comment>%s</comment>]:', $text, $default); | ||
| } | ||
|
|
||
| $output->writeln($text); | ||
|
|
||
| if ($question instanceof ChoiceQuestion) { | ||
| $width = max(array_map('strlen', array_keys($question->getChoices()))); | ||
|
|
||
| foreach ($question->getChoices() as $key => $value) { | ||
| $output->writeln(sprintf(" [<comment>%-${width}s</comment>] %s", $key, $value)); | ||
| } | ||
| } | ||
|
|
||
| $output->write(' > '); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function writeError(OutputInterface $output, \Exception $error) | ||
| { | ||
| if ($output instanceof SymfonyStyle) { | ||
| $output->newLine(); | ||
| $output->error($error->getMessage()); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| parent::writeError($output, $error); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Console\Style; | ||
|
|
||
| use Symfony\Component\Console\Formatter\OutputFormatterInterface; | ||
| use Symfony\Component\Console\Helper\ProgressBar; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| /** | ||
| * Decorates output to add console style guide helpers | ||
| * | ||
| * @author Kevin Bond <kevinbond@gmail.com> | ||
| */ | ||
| abstract class OutputStyle implements OutputInterface, StyleInterface | ||
| { | ||
| private $output; | ||
|
|
||
| /** | ||
| * @param OutputInterface $output | ||
| */ | ||
| public function __construct(OutputInterface $output) | ||
| { | ||
| $this->output = $output; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function newLine($count = 1) | ||
| { | ||
| $this->output->write(str_repeat(PHP_EOL, $count)); | ||
| } | ||
|
|
||
| /** | ||
| * @param int $max | ||
| * | ||
| * @return ProgressBar | ||
| */ | ||
| public function createProgressBar($max = 0) | ||
| { | ||
| return new ProgressBar($this->output, $max); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL) | ||
| { | ||
| $this->output->write($messages, $newline, $type); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function writeln($messages, $type = self::OUTPUT_NORMAL) | ||
| { | ||
| $this->output->writeln($messages, $type); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function setVerbosity($level) | ||
| { | ||
| $this->output->setVerbosity($level); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getVerbosity() | ||
| { | ||
| return $this->output->getVerbosity(); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function setDecorated($decorated) | ||
| { | ||
| $this->output->setDecorated($decorated); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function isDecorated() | ||
| { | ||
| return $this->output->isDecorated(); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function setFormatter(OutputFormatterInterface $formatter) | ||
| { | ||
| $this->output->setFormatter($formatter); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getFormatter() | ||
| { | ||
| return $this->output->getFormatter(); | ||
| } | ||
| } |
Oops, something went wrong.