Updated to Drupal 8.5. Core Media not yet in use.

[yaffs-website] / vendor / symfony / console / Descriptor / MarkdownDescriptor.php

diff --git a/vendor/symfony/console/Descriptor/MarkdownDescriptor.php b/vendor/symfony/console/Descriptor/MarkdownDescriptor.php
index c2d6243e280cc322f31c39f9f6757f9bb3f6c55e..d52ba55342fa00b5c59ce603d631e30cba2ad4f3 100644 (file)
--- a/vendor/symfony/console/Descriptor/MarkdownDescriptor.php
+++ b/vendor/symfony/console/Descriptor/MarkdownDescriptor.php
@@ -17,6 +17,7 @@ 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;
 
 /**
  * Markdown descriptor.
@@ -27,17 +28,37 @@ use Symfony\Component\Console\Input\InputOption;
  */
 class MarkdownDescriptor extends Descriptor
 {
+    /**
+     * {@inheritdoc}
+     */
+    public function describe(OutputInterface $output, $object, array $options = array())
+    {
+        $decorated = $output->isDecorated();
+        $output->setDecorated(false);
+
+        parent::describe($output, $object, $options);
+
+        $output->setDecorated($decorated);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function write($content, $decorated = true)
+    {
+        parent::write($content, $decorated);
+    }
+
     /**
      * {@inheritdoc}
      */
     protected function describeInputArgument(InputArgument $argument, array $options = array())
     {
         $this->write(
-            '**'.$argument->getName().':**'."\n\n"
-            .'* Name: '.($argument->getName() ?: '<none>')."\n"
+            '#### `'.($argument->getName() ?: '<none>')."`\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"
-            .'* Description: '.preg_replace('/\s*[\r\n]\s*/', "\n  ", $argument->getDescription() ?: '<none>')."\n"
             .'* Default: `'.str_replace("\n", '', var_export($argument->getDefault(), true)).'`'
         );
     }
@@ -47,14 +68,17 @@ class MarkdownDescriptor extends Descriptor
      */
     protected function describeInputOption(InputOption $option, array $options = array())
     {
+        $name = '--'.$option->getName();
+        if ($option->getShortcut()) {
+            $name .= '|-'.str_replace('|', '|-', $option->getShortcut()).'';
+        }
+
         $this->write(
-            '**'.$option->getName().':**'."\n\n"
-            .'* Name: `--'.$option->getName().'`'."\n"
-            .'* Shortcut: '.($option->getShortcut() ? '`-'.implode('|-', explode('|', $option->getShortcut())).'`' : '<none>')."\n"
+            '#### `'.$name.'`'."\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"
-            .'* Description: '.preg_replace('/\s*[\r\n]\s*/', "\n  ", $option->getDescription() ?: '<none>')."\n"
             .'* Default: `'.str_replace("\n", '', var_export($option->getDefault(), true)).'`'
         );
     }
@@ -65,7 +89,7 @@ class MarkdownDescriptor extends Descriptor
     protected function describeInputDefinition(InputDefinition $definition, array $options = array())
     {
         if ($showArguments = count($definition->getArguments()) > 0) {
-            $this->write('### Arguments:');
+            $this->write('### Arguments');
             foreach ($definition->getArguments() as $argument) {
                 $this->write("\n\n");
                 $this->write($this->describeInputArgument($argument));
@@ -77,7 +101,7 @@ class MarkdownDescriptor extends Descriptor
                 $this->write("\n\n");
             }
 
-            $this->write('### Options:');
+            $this->write('### Options');
             foreach ($definition->getOptions() as $option) {
                 $this->write("\n\n");
                 $this->write($this->describeInputOption($option));
@@ -94,12 +118,12 @@ class MarkdownDescriptor extends Descriptor
         $command->mergeApplicationDefinition(false);
 
         $this->write(
-            $command->getName()."\n"
-            .str_repeat('-', Helper::strlen($command->getName()))."\n\n"
-            .'* Description: '.($command->getDescription() ?: '<none>')."\n"
-            .'* Usage:'."\n\n"
+            '`'.$command->getName()."`\n"
+            .str_repeat('-', Helper::strlen($command->getName()) + 2)."\n\n"
+            .($command->getDescription() ? $command->getDescription()."\n\n" : '')
+            .'### Usage'."\n\n"
             .array_reduce(array_merge(array($command->getSynopsis()), $command->getAliases(), $command->getUsages()), function ($carry, $usage) {
-                return $carry.'  * `'.$usage.'`'."\n";
+                return $carry.'* `'.$usage.'`'."\n";
             })
         );
 
@@ -121,8 +145,9 @@ class MarkdownDescriptor extends Descriptor
     {
         $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
         $description = new ApplicationDescription($application, $describedNamespace);
+        $title = $this->getApplicationTitle($application);
 
-        $this->write($application->getName()."\n".str_repeat('=', Helper::strlen($application->getName())));
+        $this->write($title."\n".str_repeat('=', Helper::strlen($title)));
 
         foreach ($description->getNamespaces() as $namespace) {
             if (ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) {
@@ -131,8 +156,8 @@ class MarkdownDescriptor extends Descriptor
             }
 
             $this->write("\n\n");
-            $this->write(implode("\n", array_map(function ($commandName) {
-                return '* '.$commandName;
+            $this->write(implode("\n", array_map(function ($commandName) use ($description) {
+                return sprintf('* [`%s`](#%s)', $commandName, str_replace(':', '', $description->getCommand($commandName)->getName()));
             }, $namespace['commands'])));
         }
 
@@ -141,4 +166,17 @@ class MarkdownDescriptor extends Descriptor
             $this->write($this->describeCommand($command));
         }
     }
+
+    private function getApplicationTitle(Application $application)
+    {
+        if ('UNKNOWN' !== $application->getName()) {
+            if ('UNKNOWN' !== $application->getVersion()) {
+                return sprintf('%s %s', $application->getName(), $application->getVersion());
+            }
+
+            return $application->getName();
+        }
+
+        return 'Console Tool';
+    }
 }