Add ReStructuredText descriptor for console component. #45718
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,210 @@ | ||
| <?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\Descriptor; | ||
|
|
||
| use Symfony\Component\Console\Application; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Helper\Helper; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputDefinition; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| /** | ||
| * ReStructuredTextDescriptor descriptor. | ||
| */ | ||
| class ReStructuredTextDescriptor extends Descriptor | ||
| { | ||
| private $applicationTitleUnderlineChar = '#'; | ||
|
There was a problem hiding this comment. Some context in case anyone needs it: RST format doesn't define which characters to use for I'm not saying that we need to do the same here, but, for your consideration, the standard notation that we follow in Symfony Docs is: Here we would be using: |
||
| private $commandTitleUnderlineChar = '*'; | ||
| private $argumentsTitleUnderlineChar = '='; | ||
| private $argumentTitleUnderlineChar = '-'; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function describe(OutputInterface $output, object $object, array $options = []) | ||
| { | ||
| $decorated = $output->isDecorated(); | ||
| $output->setDecorated(false); | ||
|
|
||
| parent::describe($output, $object, $options); | ||
|
|
||
| $output->setDecorated($decorated); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function write(string $content, bool $decorated = true) | ||
| { | ||
| parent::write($content, $decorated); | ||
|
There was a problem hiding this comment. why overriding the method to do nothing else than calling the parent ? |
||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputArgument(InputArgument $argument, array $options = []) | ||
| { | ||
| $this->write( | ||
| '``'.($argument->getName() ?: '<none>')."``\n".str_repeat($this->argumentTitleUnderlineChar, Helper::width($argument->getName()) + 4)."\n\n" | ||
|
|
||
| .($argument->getDescription() ? preg_replace('/\s*[\r\n]\s*/', "\n", $argument->getDescription())."\n\n" : '') | ||
| .'- Is required: '.($argument->isRequired() ? 'yes' : 'no')."\n" | ||
| .'- Is array: '.($argument->isArray() ? 'yes' : 'no')."\n" | ||
| .'- Default: ``'.str_replace("\n", '', var_export($argument->getDefault(), true)).'``' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputOption(InputOption $option, array $options = []) | ||
| { | ||
| $name = '--'.$option->getName(); | ||
| if ($option->isNegatable()) { | ||
| $name .= '|--no-'.$option->getName(); | ||
| } | ||
| if ($option->getShortcut()) { | ||
| $name .= '|-'.str_replace('|', '|-', $option->getShortcut()).''; | ||
| } | ||
|
|
||
| $this->write( | ||
| '``'.$name.'``'."\n".str_repeat($this->argumentTitleUnderlineChar, Helper::width($name) + 4)."\n\n" | ||
|
|
||
| .($option->getDescription() ? preg_replace('/\s*[\r\n]\s*/', "\n", $option->getDescription())."\n\n" : '') | ||
| .'- Accept value: '.($option->acceptValue() ? 'yes' : 'no')."\n" | ||
| .'- Is value required: '.($option->isValueRequired() ? 'yes' : 'no')."\n" | ||
| .'- Is multiple: '.($option->isArray() ? 'yes' : 'no')."\n" | ||
| .'- Is negatable: '.($option->isNegatable() ? 'yes' : 'no')."\n" | ||
| .'- Default: ``'.str_replace("\n", '', var_export($option->getDefault(), true)).'``' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeInputDefinition(InputDefinition $definition, array $options = []) | ||
| { | ||
| if ($showArguments = \count($definition->getArguments()) > 0) { | ||
| $this->write("Arguments\n".str_repeat($this->argumentsTitleUnderlineChar, 9))."\n\n"; | ||
| foreach ($definition->getArguments() as $argument) { | ||
| $this->write("\n\n"); | ||
| if (null !== $describeInputArgument = $this->describeInputArgument($argument)) { | ||
| $this->write($describeInputArgument); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (\count($definition->getOptions()) > 0) { | ||
| if ($showArguments) { | ||
| $this->write("\n\n"); | ||
| } | ||
|
|
||
| $this->write("Options\n".str_repeat($this->argumentsTitleUnderlineChar, 7))."\n\n"; | ||
| foreach ($definition->getOptions() as $option) { | ||
| $this->write("\n\n"); | ||
| if (null !== $describeInputOption = $this->describeInputOption($option)) { | ||
| $this->write($describeInputOption); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeCommand(Command $command, array $options = []) | ||
| { | ||
| if ($options['short'] ?? false) { | ||
| $this->write( | ||
| '``'.$command->getName()."``\n" | ||
| .str_repeat($this->commandTitleUnderlineChar, Helper::width($command->getName()) + 4)."\n\n" | ||
| .($command->getDescription() ? $command->getDescription()."\n\n" : '') | ||
| ."Usage\n".str_repeat($this->argumentsTitleUnderlineChar, 5)."\n\n" | ||
| .array_reduce($command->getAliases(), function ($carry, $usage) { | ||
| return $carry.'- ``'.$usage.'``'."\n"; | ||
| }) | ||
| ); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $command->mergeApplicationDefinition(false); | ||
|
|
||
| foreach ($command->getAliases() as $alias) { | ||
| $this->write('.. _'.$alias.":\n\n"); | ||
| } | ||
| $this->write( | ||
| '``'.$command->getName()."``\n" | ||
| .str_repeat($this->commandTitleUnderlineChar, Helper::width($command->getName()) + 4)."\n\n" | ||
| .($command->getDescription() ? $command->getDescription()."\n\n" : '') | ||
| ."Usage\n".str_repeat($this->argumentsTitleUnderlineChar, 5)."\n\n" | ||
| .array_reduce(array_merge([$command->getSynopsis()], $command->getAliases(), $command->getUsages()), function ($carry, $usage) { | ||
| return $carry.'- ``'.$usage.'``'."\n"; | ||
| }) | ||
| ); | ||
|
|
||
| if ($help = $command->getProcessedHelp()) { | ||
| $this->write("\n"); | ||
| $this->write($help); | ||
| } | ||
|
|
||
| $definition = $command->getDefinition(); | ||
| if ($definition->getOptions() || $definition->getArguments()) { | ||
| $this->write("\n\n"); | ||
| $this->describeInputDefinition($definition); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function describeApplication(Application $application, array $options = []) | ||
| { | ||
| $describedNamespace = $options['namespace'] ?? null; | ||
| $description = new ApplicationDescription($application, $describedNamespace); | ||
| $title = $this->getApplicationTitle($application); | ||
|
|
||
| $this->write($title."\n".str_repeat($this->applicationTitleUnderlineChar, Helper::width($title))); | ||
|
|
||
| foreach ($description->getNamespaces() as $namespace) { | ||
| if (ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) { | ||
| $this->write("\n\n"); | ||
| $this->write('**'.$namespace['id'].':**'); | ||
| } | ||
|
|
||
| $this->write("\n\n"); | ||
| $this->write(implode("\n", array_map(function ($commandName) { | ||
| return sprintf('- `%s`_', $commandName); | ||
| }, $namespace['commands']))); | ||
| } | ||
|
|
||
| foreach ($description->getCommands() as $command) { | ||
| $this->write("\n\n"); | ||
| if (null !== $describeCommand = $this->describeCommand($command, $options)) { | ||
| $this->write($describeCommand); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private function getApplicationTitle(Application $application): string | ||
| { | ||
| if ('UNKNOWN' !== $application->getName()) { | ||
| if ('UNKNOWN' !== $application->getVersion()) { | ||
| return sprintf('%s %s', $application->getName(), $application->getVersion()); | ||
| } | ||
|
|
||
| return $application->getName(); | ||
| } | ||
|
|
||
| return 'Console Tool'; | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,45 @@ | ||
| <?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\Tests\Descriptor; | ||
|
|
||
| use Symfony\Component\Console\Descriptor\ReStructuredTextDescriptor; | ||
| use Symfony\Component\Console\Tests\Fixtures\DescriptorApplicationMbString; | ||
| use Symfony\Component\Console\Tests\Fixtures\DescriptorCommandMbString; | ||
|
|
||
| class ReStructuredTextDescriptorTest extends AbstractDescriptorTest | ||
| { | ||
| public function getDescribeCommandTestData() | ||
| { | ||
| return $this->getDescriptionTestData(array_merge( | ||
| ObjectsProvider::getCommands(), | ||
| ['command_mbstring' => new DescriptorCommandMbString()] | ||
| )); | ||
| } | ||
|
|
||
| public function getDescribeApplicationTestData() | ||
| { | ||
| return $this->getDescriptionTestData(array_merge( | ||
| ObjectsProvider::getApplications(), | ||
| ['application_mbstring' => new DescriptorApplicationMbString()] | ||
| )); | ||
| } | ||
|
|
||
| protected function getDescriptor() | ||
| { | ||
| return new ReStructuredTextDescriptor(); | ||
| } | ||
|
|
||
| protected function getFormat() | ||
| { | ||
| return 'rst'; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can be removed