Finish Zsh completion

Author: GromNaN

Command/CompleteCommand.php

@@ -28,7 +28,6 @@
  * Responsible for providing the values to the shell completion.
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
- * @author Jitendra A <adhocore@gmail.com>
  */
 #[AsCommand(name: '|_complete', description: 'Internal command to provide shell completion suggestions')]
 final class CompleteCommand extends Command
@@ -188,7 +187,6 @@ private function createCompletionInput(InputInterface $input): CompletionInput
         }
 
         $completionInput = CompletionInput::fromTokens($input->getOption('input'), (int) $currentIndex);
-        $completionInput->setShell($input->getOption('shell'));
 
         try {
             $completionInput->bind($this->getApplication()->getDefinition());

Command/DumpCompletionCommand.php

@@ -48,6 +48,7 @@ protected function configure()
         $shell = $this->guessShell();
         [$rcFile, $completionFile] = match ($shell) {
             'fish' => ['~/.config/fish/config.fish', "/etc/fish/completions/$commandName.fish"],
+            'zsh' => ['~/.zshrc', '$fpath[1]/'.$commandName],
             default => ['~/.bashrc', "/etc/bash_completion.d/$commandName"],
         };
 

Completion/CompletionInput.php

@@ -23,7 +23,6 @@
  * completion is expected.
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
- * @author Jitendra A <adhocore@gmail.com>
  */
 final class CompletionInput extends ArgvInput
 {
@@ -33,7 +32,6 @@ final class CompletionInput extends ArgvInput
     public const TYPE_NONE = 'none';
 
     private $tokens;
-    private $shell = '';
     private $currentIndex;
     private $completionType;
     private $completionName = null;
@@ -181,16 +179,6 @@ public function mustSuggestArgumentValuesFor(string $argumentName): bool
         return self::TYPE_ARGUMENT_VALUE === $this->getCompletionType() && $argumentName === $this->getCompletionName();
     }
 
-    public function setShell(string $shell): void
-    {
-        $this->shell = $shell;
-    }
-
-    public function isShell(string $shell): bool
-    {
-        return $this->shell === $shell;
-    }
-
     protected function parseToken(string $token, bool $parseOptions): bool
     {
         try {

Completion/Suggestion.php

@@ -16,7 +16,7 @@
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
  */
-class Suggestion
+class Suggestion implements \Stringable
 {
     public function __construct(
         private readonly string $value,

Resources/completion.zsh

@@ -31,7 +31,7 @@ _sf_{{ COMMAND_NAME }}() {
     fi
 
     # Prepare the command to obtain completions
-    requestComp="${words[0]} ${words[1]} _complete -szsh -S{{ VERSION }} -c$((CURRENT-1))" i=""
+    requestComp="${words[0]} ${words[1]} _complete -szsh -a{{ VERSION }} -c$((CURRENT-1))" i=""
     for w in ${words[@]}; do
         w=$(printf -- '%b' "$w")
         # remove quotes from typed values
@@ -49,7 +49,7 @@ _sf_{{ COMMAND_NAME }}() {
         fi
     done
 
-    # Ensure atleast 1 input
+    # Ensure at least 1 input
     if [ "${i}" = "" ]; then
         requestComp="${requestComp} -i\" \""
     else

Tests/Command/CompleteCommandTest.php

@@ -125,57 +125,6 @@ public function provideCompleteCommandInputDefinitionInputs()
         yield 'custom-aliased' => [['bin/console', 'ahoy'], ['Fabien', 'Robin', 'Wouter']];
     }
 
-    /**
-     * @dataProvider provideZshCompleteCommandNameInputs
-     */
-    public function testZshCompleteCommandName(array $input, array $suggestions)
-    {
-        $this->execute(['--current' => '1', '--input' => $input, '--shell' => 'zsh']);
-        $this->assertEquals(implode("\n", $suggestions).\PHP_EOL, $this->tester->getDisplay());
-    }
-
-    public function provideZshCompleteCommandNameInputs()
-    {
-        yield 'empty' => [['bin/console'], [
-            'help'."\t".'Display help for a command',
-            'list'."\t".'List commands',
-            'completion'."\t".'Dump the shell completion script',
-            'hello'."\t".'Hello test command',
-            'ahoy'."\t".'Hello test command',
-        ]];
-        yield 'partial' => [['bin/console', 'he'], [
-            'help'."\t".'Display help for a command',
-            'list'."\t".'List commands',
-            'completion'."\t".'Dump the shell completion script',
-            'hello'."\t".'Hello test command',
-            'ahoy'."\t".'Hello test command',
-        ]];
-        yield 'complete-shortcut-name' => [['bin/console', 'hell'], ['hello', 'ahoy']];
-    }
-
-    /**
-     * @dataProvider provideZshCompleteCommandInputDefinitionInputs
-     */
-    public function testZshCompleteCommandInputDefinition(array $input, array $suggestions)
-    {
-        $this->execute(['--current' => '2', '--input' => $input, '--shell' => 'zsh']);
-        $this->assertEquals(implode("\n", $suggestions).\PHP_EOL, $this->tester->getDisplay());
-    }
-
-    public function provideZshCompleteCommandInputDefinitionInputs()
-    {
-        yield 'definition' => [['bin/console', 'hello', '-'], [
-            '--help'."\t".'Display help for the given command. When no command is given display help for the list command',
-            '--quiet'."\t".'Do not output any message',
-            '--verbose'."\t".'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug',
-            '--version'."\t".'Display this application version',
-            '--ansi'."\t".'Force (or disable --no-ansi) ANSI output',
-            '--no-ansi'."\t".'Force (or disable --no-ansi) ANSI output',
-            '--no-interaction'."\t".'Do not ask any interactive question',
-        ]];
-        yield 'custom' => [['bin/console', 'hello'], ['Fabien', 'Robin', 'Wouter']];
-    }
-
     private function execute(array $input)
     {
         // run in verbose mode to assert exceptions

Tests/Completion/CompletionInputTest.php

@@ -132,12 +132,4 @@ public function provideFromStringData()
         yield ['bin/console cache:clear "multi word string"', ['bin/console', 'cache:clear', '"multi word string"']];
         yield ['bin/console cache:clear \'multi word string\'', ['bin/console', 'cache:clear', '\'multi word string\'']];
     }
-
-    public function testShell()
-    {
-        $input = CompletionInput::fromString('bin/console cache:clear \'multi word string\'', 1);
-        $input->setShell('zsh');
-
-        $this->assertTrue($input->isShell('zsh'));
-    }
 }

Tests/Completion/Output/CompletionOutputTestCase.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Completion\Output\CompletionOutputInterface;
+use Symfony\Component\Console\Completion\Suggestion;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\StreamOutput;
 
@@ -28,8 +29,8 @@ abstract public function getExpectedValuesOutput(): string;
     public function testOptionsOutput()
     {
         $options = [
-            new InputOption('option1', 'o', InputOption::VALUE_NONE),
-            new InputOption('negatable', null, InputOption::VALUE_NEGATABLE),
+            new InputOption('option1', 'o', InputOption::VALUE_NONE, 'First Option'),
+            new InputOption('negatable', null, InputOption::VALUE_NEGATABLE, 'Can be negative'),
         ];
         $suggestions = new CompletionSuggestions();
         $suggestions->suggestOptions($options);
@@ -42,7 +43,11 @@ public function testOptionsOutput()
     public function testValuesOutput()
     {
         $suggestions = new CompletionSuggestions();
-        $suggestions->suggestValues(['Green', 'Red', 'Yellow']);
+        $suggestions->suggestValues([
+            new Suggestion('Green', 'Beans are green'),
+            new Suggestion('Red', 'Rose are red'),
+            new Suggestion('Yellow', 'Canaries are yellow'),
+        ]);
         $stream = fopen('php://memory', 'rw+');
         $this->getCompletionOutput()->write($suggestions, new StreamOutput($stream));
         fseek($stream, 0);

Tests/Completion/Output/ZshCompletionOutputTest.php

@@ -0,0 +1,33 @@
+<?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\Completion\Output;
+
+use Symfony\Component\Console\Completion\Output\CompletionOutputInterface;
+use Symfony\Component\Console\Completion\Output\ZshCompletionOutput;
+
+class ZshCompletionOutputTest extends CompletionOutputTestCase
+{
+    public function getCompletionOutput(): CompletionOutputInterface
+    {
+        return new ZshCompletionOutput();
+    }
+
+    public function getExpectedOptionsOutput(): string
+    {
+        return "--option1\tFirst Option\n--negatable\tCan be negative\n--no-negatable\tCan be negative\n";
+    }
+
+    public function getExpectedValuesOutput(): string
+    {
+        return "Green\tBeans are green\nRed\tRose are red\nYellow\tCanaries are yellow\n";
+    }
+}