feature #53986 [Console] Add descriptions to Fish completion output (adriaanzon)

fabpot · fabpot · commit 73f8713e143c · 2024-02-21T16:47:11.000+01:00
This PR was squashed before being merged into the 7.1 branch. Discussion ---------- [Console] Add descriptions to Fish completion output | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | N/A | License | MIT This improves the completion output for the Fish shell to include descriptions. The `-a` option of Fish's [complete](https://fishshell.com/docs/current/cmds/complete.html) command accepts a list where each line is an argument with an optional description, separated by a tab. The fish script doesn't need to change, making this change backwards compatible. Since the output is now identical to that of `ZshCompletionOutput`, code duplication could still be reduced by extracting to an abstract class (e.g. `TabSeparatedCompletionOutput`) that gets extended by `FishCompletionOutput` and `ZshCompletionOutput`. Commits ------- 1cfd6df [Console] Add descriptions to Fish completion output
diff --git a/src/Symfony/Component/Console/Completion/Output/FishCompletionOutput.php b/src/Symfony/Component/Console/Completion/Output/FishCompletionOutput.php
@@ -21,11 +21,14 @@ class FishCompletionOutput implements CompletionOutputInterface
 {
     public function write(CompletionSuggestions $suggestions, OutputInterface $output): void
     {
-        $values = $suggestions->getValueSuggestions();
+        $values = [];
+        foreach ($suggestions->getValueSuggestions() as $value) {
+            $values[] = $value->getValue().($value->getDescription() ? "\t".$value->getDescription() : '');
+        }
         foreach ($suggestions->getOptionSuggestions() as $option) {
-            $values[] = '--'.$option->getName();
+            $values[] = '--'.$option->getName().($option->getDescription() ? "\t".$option->getDescription() : '');
             if ($option->isNegatable()) {
-                $values[] = '--no-'.$option->getName();
+                $values[] = '--no-'.$option->getName().($option->getDescription() ? "\t".$option->getDescription() : '');
             }
         }
         $output->write(implode("\n", $values));
diff --git a/src/Symfony/Component/Console/Resources/completion.fish b/src/Symfony/Component/Console/Resources/completion.fish
@@ -19,11 +19,7 @@ function _sf_{{ COMMAND_NAME }}
 
     set completecmd $completecmd "-c$c"
 
-    set sfcomplete ($completecmd)
-
-    for i in $sfcomplete
-        echo $i
-    end
+    $completecmd
 end
 
 complete -c '{{ COMMAND_NAME }}' -a '(_sf_{{ COMMAND_NAME }})' -f
diff --git a/src/Symfony/Component/Console/Tests/Completion/Output/FishCompletionOutputTest.php b/src/Symfony/Component/Console/Tests/Completion/Output/FishCompletionOutputTest.php
@@ -23,11 +23,11 @@ public function getCompletionOutput(): CompletionOutputInterface
 
     public function getExpectedOptionsOutput(): string
     {
-        return "--option1\n--negatable\n--no-negatable";
+        return "--option1\tFirst Option\n--negatable\tCan be negative\n--no-negatable\tCan be negative";
     }
 
     public function getExpectedValuesOutput(): string
     {
-        return "Green\nRed\nYellow";
+        return "Green\tBeans are green\nRed\tRose are red\nYellow\tCanaries are yellow";
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,14 @@ class FishCompletionOutput implements CompletionOutputInterface`
`21`	`21`	`{`
`22`	`22`	`public function write(CompletionSuggestions $suggestions, OutputInterface $output): void`
`23`	`23`	`{`
`24`		`- $values = $suggestions->getValueSuggestions();`
	`24`	`+ $values = [];`
	`25`	`+ foreach ($suggestions->getValueSuggestions() as $value) {`
	`26`	`+ $values[] = $value->getValue().($value->getDescription() ? "\t".$value->getDescription() : '');`
	`27`	`+ }`
`25`	`28`	`foreach ($suggestions->getOptionSuggestions() as $option) {`
`26`		`- $values[] = '--'.$option->getName();`
	`29`	`+ $values[] = '--'.$option->getName().($option->getDescription() ? "\t".$option->getDescription() : '');`
`27`	`30`	`if ($option->isNegatable()) {`
`28`		`- $values[] = '--no-'.$option->getName();`
	`31`	`+ $values[] = '--no-'.$option->getName().($option->getDescription() ? "\t".$option->getDescription() : '');`
`29`	`32`	`}`
`30`	`33`	`}`
`31`	`34`	`$output->write(implode("\n", $values));`
Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ public function getCompletionOutput(): CompletionOutputInterface`
`23`	`23`
`24`	`24`	`public function getExpectedOptionsOutput(): string`
`25`	`25`	`{`
`26`		`- return "--option1\n--negatable\n--no-negatable";`
	`26`	`+ return "--option1\tFirst Option\n--negatable\tCan be negative\n--no-negatable\tCan be negative";`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`public function getExpectedValuesOutput(): string`
`30`	`30`	`{`
`31`		`- return "Green\nRed\nYellow";`
	`31`	`+ return "Green\tBeans are green\nRed\tRose are red\nYellow\tCanaries are yellow";`
`32`	`32`	`}`
`33`	`33`	`}`