Add Suggestion class for more advanced completion suggestion

Author: wouterj

Completion/CompletionSuggestions.php

@@ -18,33 +18,37 @@
  *
  * @author Wouter de Jong <[email protected]>
  */
-class CompletionSuggestions
+final class CompletionSuggestions
 {
     private $valueSuggestions = [];
     private $optionSuggestions = [];
 
     /**
      * Add a suggested value for an input option or argument.
      *
+     * @param string|Suggestion $value
+     *
      * @return $this
      */
-    public function suggestValue(string $value): self
+    public function suggestValue($value): self
     {
-        $this->valueSuggestions[] = $value;
+        $this->valueSuggestions[] = !$value instanceof Suggestion ? new Suggestion($value) : $value;
 
         return $this;
     }
 
     /**
      * Add multiple suggested values at once for an input option or argument.
      *
-     * @param string[] $values
+     * @param list<string|Suggestion> $values
      *
      * @return $this
      */
     public function suggestValues(array $values): self
     {
-        $this->valueSuggestions = array_merge($this->valueSuggestions, $values);
+        foreach ($values as $value) {
+            $this->suggestValue($value);
+        }
 
         return $this;
     }
@@ -86,7 +90,7 @@ public function getOptionSuggestions(): array
     }
 
     /**
-     * @return string[]
+     * @return Suggestion[]
      */
     public function getValueSuggestions(): array
     {

Completion/Output/BashCompletionOutput.php

@@ -21,10 +21,10 @@ class BashCompletionOutput implements CompletionOutputInterface
 {
     public function write(CompletionSuggestions $suggestions, OutputInterface $output): void
     {
-        $options = $suggestions->getValueSuggestions();
+        $values = $suggestions->getValueSuggestions();
         foreach ($suggestions->getOptionSuggestions() as $option) {
-            $options[] = '--'.$option->getName();
+            $values[] = '--'.$option->getName();
         }
-        $output->writeln(implode("\n", $options));
+        $output->writeln(implode("\n", $values));
     }
 }

Completion/Suggestion.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Completion;
+
+/**
+ * Represents a single suggested value.
+ *
+ * @author Wouter de Jong <[email protected]>
+ */
+class Suggestion
+{
+    private $value;
+
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    public function __toString(): string
+    {
+        return $this->getValue();
+    }
+}

Tester/CommandCompletionTester.php

@@ -51,6 +51,6 @@ public function complete(array $input): array
             $options[] = '--'.$option->getName();
         }
 
-        return array_merge($options, $suggestions->getValueSuggestions());
+        return array_map('strval', array_merge($options, $suggestions->getValueSuggestions()));
     }
 }