Add suggestions for the option 'format' of lints commands: twig, yaml and xliff

Author: makraz

Command/LintCommand.php

@@ -13,6 +13,8 @@
 
 use Symfony\Component\Console\CI\GithubActionReporter;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Completion\CompletionInput;
+use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputArgument;
@@ -277,4 +279,11 @@ private function isReadable(string $fileOrDirectory): bool
 
         return $default($fileOrDirectory);
     }
+
+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+        if ($input->mustSuggestOptionValuesFor('format')) {
+            $suggestions->suggestValues(['txt', 'json', 'github']);
+        }
+    }
 }

Tests/Command/LintCommandTest.php

@@ -14,7 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\CI\GithubActionReporter;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Tester\CommandCompletionTester;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\Yaml\Command\LintCommand;
 
@@ -163,6 +165,21 @@ public function testLintFileNotReadable()
         $tester->execute(['filename' => $filename], ['decorated' => false]);
     }
 
+    /**
+     * @dataProvider provideCompletionSuggestions
+     */
+    public function testComplete(array $input, array $expectedSuggestions)
+    {
+        $tester = new CommandCompletionTester($this->createCommand());
+
+        $this->assertSame($expectedSuggestions, $tester->complete($input));
+    }
+
+    public function provideCompletionSuggestions()
+    {
+        yield 'option' => [['--format', ''], ['txt', 'json', 'github']];
+    }
+
     private function createFile($content): string
     {
         $filename = tempnam(sys_get_temp_dir().'/framework-yml-lint-test', 'sf-');
@@ -173,13 +190,17 @@ private function createFile($content): string
         return $filename;
     }
 
-    protected function createCommandTester(): CommandTester
+    protected function createCommand(): Command
     {
         $application = new Application();
         $application->add(new LintCommand());
-        $command = $application->find('lint:yaml');
 
-        return new CommandTester($command);
+        return $application->find('lint:yaml');
+    }
+
+    protected function createCommandTester(): CommandTester
+    {
+        return new CommandTester($this->createCommand());
     }
 
     protected function setUp(): void